Public Member Functions |
| __construct ($config, $soap) |
| VirageSearch ($token, $query) |
| VirageSearch2 ($token, $query, $getImages=false) |
| VirageGetDocument ($token, $document_id, $getImages) |
| VirageGetDocumentImages ($token, $document_id) |
| VirageGetFullText ($token, $document_id, $document=null) |
| VirageGetWords ($token, $document_id, $complete=null, $document=null) |
| GetVirageDocumentImage ($token, $document_id, $index, $type, $getContent=true, $cache=false, $document=null) |
| VirageGetDocumentHeadlines ($token, $document_id, $document=null, $limit=10) |
| VirageGetDocumentAllImages ($token, $document_id, $type, $getContent, $cache, $document=null) |
Data Fields |
| $soap |
Protected Attributes |
| $config = null |
Constructor & Destructor Documentation
Member Function Documentation
GetVirageDocumentImage |
( |
$ |
token, |
|
|
$ |
document_id, |
|
|
$ |
index, |
|
|
$ |
type, |
|
|
$ |
getContent = true , |
|
|
$ |
cache = false , |
|
|
$ |
document = null |
|
) |
| |
Gets a single image from a Virage document
- Parameters:
-
string | $token | The session identifier |
string | $document_id | The document identifier |
int | $index | The image index |
string | $type | The type of image to retrieve (small or big) |
boolean | $getContent | If set to false, do not retrieve the image content [OPTIONAL] |
boolean | $cache | If set to true, also cache the image [OPTIONAL] |
VirageDocument | $document | The Virage document [OPTIONAL] public |
- Returns:
- VirageDocumentImage
Get a Virage document
- Parameters:
-
string | $token | The session identifier |
string | $document_id | The document identifier |
boolean | $getImages | If true, then it also returns the document images |
- Returns:
- VirageDocument
Gets all the images from a document
- Parameters:
-
string | $token | The session identifier |
string | $document_id | The document identifier |
string | $type | The type of image to retrieve (small or big) |
boolean | $getContent | If set to false, do not retrieve the image content [OPTIONAL] |
boolean | $cache | If set to true, also cache the image [OPTIONAL] |
VirageDocument | $document | The document [OPTIONAL] public |
- Returns:
- VirageDocumentImage[]
Gets all the headlines of a video document
- Parameters:
-
string | $token | The session identifier |
string | $document_id | The document identifier |
VirageDocument | $document | The document [OPTIONAL] |
int | $limit | The limit of characters for a headline [OPTIONAL] public |
- Returns:
- VirageHeadline[]
Get a Virage document images by calling the private method _VirageGetDocumentImages (this does not require authentication)
- Parameters:
-
string | $token | The session identifier |
string | $document_id | The document identifier |
- Returns:
- VirageDocumentImages
Get the full text of a video document
- Parameters:
-
string | $token | The session identifier |
string | $document_id | The document identifier |
VirageDocument | $document | The document [OPTIONAL] public |
- Returns:
- string
VirageGetWords |
( |
$ |
token, |
|
|
$ |
document_id, |
|
|
$ |
complete = null , |
|
|
$ |
document = null |
|
) |
| |
Gets the list of words
- Parameters:
-
string | $token | The session identifier |
string | $document_id | The document identifier |
boolean | $complete | If set to true, get the words for the entire movie [OPTIONAL] |
VirageDocument | $document | The document [OPTIONAL] public |
- Returns:
- VirageWord[]
Search for a video in the database using Virage and returns the complete document without the images
- Parameters:
-
string | $token | The session identifier |
VirageSearchQuery | $query | The query to be executed |
boolean | $getImages | If set to true, get the images also [OPTIONAL] |
- Returns:
- VirageSearchResult
Field Documentation
$config = null [protected] |
The documentation for this class was generated from the following file: