Skip to content

Commit 74771c7

Browse files
committed
modified readme
1 parent d9e75a0 commit 74771c7

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,28 @@ $Info->providerName;
4646
$Info->providerUrl;
4747
```
4848

49+
Available options
50+
-----------------
51+
52+
* minImageWidth (int): Minimal image width used to choose the main image
53+
* minImageHeight (int): Minimal image height used to choose the main image
54+
* getBiggerImage (bool): Returns the bigger image as the main image (instead the first found). This can make the request slower because it need to check the size of all images.
55+
* getBiggerIcon (bool): The same than getBiggerImage but used to choose the main icon
56+
* facebookAccessToken (string): Used to get info from facebook pages when these pages are not public and a access token is required
57+
* soundcloudClientId (string): Used to get info of links from soundcloud. By default, it uses "YOUR_CLIENT_ID" that its a valid client id :P
58+
* embedlyKey (string): If it's defined, get info from embedly service (only for know supported services and if the page doesn't have its own oembed service)
59+
60+
```php
61+
$options = array(
62+
'getBiggerImage' => true
63+
);
64+
65+
$Url = new Embed\Url('https://www.youtube.com/watch?v=PP1xn5wHtxE');
66+
67+
$Info = Embed\Embed::create($Url, $options);
68+
```
69+
70+
4971
Online demo
5072
-----------
5173

0 commit comments

Comments
 (0)