Difference between revisions of "ExtraMetadata"
Jump to navigation
Jump to search
| (12 intermediate revisions by 3 users not shown) | |||
| Line 13: | Line 13: | ||
! ChannelId | ! ChannelId | ||
| − | {{!}} | + | {{!}} string |
| − | {{!}} | + | {{!}} The LiveChannel ID of this catalogItem. Applies to [[CatalogItemType]]: |
| + | * '''Schedule''' (64) | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
! ChannelTitle | ! ChannelTitle | ||
| − | {{!}} | + | {{!}} string |
| − | {{!}} | + | {{!}} The LiveChannel Title of this catalogItem. Applies to [[CatalogItemType]]: |
| + | * '''Schedule''' (64) | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
! ProgramId | ! ProgramId | ||
| − | {{!}} | + | {{!}} string |
| − | {{!}} | + | {{!}} The ProgramID of this catalogItem. Applies to [[CatalogItemType]]: |
| + | * '''Schedule''' (64) | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Stars | ! Stars | ||
| − | {{!}} | + | {{!}} float |
| − | {{!}} | + | {{!}} The Stars of this catalogItem. Applies to [[CatalogItemType]]: |
| + | * '''Movie''' (1) | ||
| + | * '''Serie''' (512) | ||
| + | * '''Season''' (1024) | ||
| + | * '''Episode''' (2048) | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Duration | ! Duration | ||
{{!}} int | {{!}} int | ||
| − | {{!}} | + | {{!}} The Duration of this catalogItem. Applies to [[CatalogItemType]]: |
| + | * '''Movie''' (1) | ||
| + | * '''Schedule''' (64) | ||
| + | * '''Serie''' (512) | ||
| + | * '''Season''' (1024) | ||
| + | * '''Episode''' (2048) | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| − | ! | + | ! ChildrenCount |
{{!}} int | {{!}} int | ||
| − | {{!}} | + | {{!}} The number of children of this catalogItem. Applies to [[CatalogItemType]]: |
| + | * '''Movie''' (1) | ||
| + | * '''Serie''' (512) | ||
| + | * '''Season''' (1024) | ||
| + | * '''Episode''' (2048) | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
! CallLetter | ! CallLetter | ||
| − | {{!}} | + | {{!}} string |
| − | {{!}} | + | {{!}} {{!}} The CallLetter of the liveChannel of this catalogItem. Applies to [[CatalogItemType]]: |
| + | * '''Schedule''' (64) | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
! ChannelNumber | ! ChannelNumber | ||
| + | {{!}} sting | ||
| + | {{!}} The ChannelNumber of the liveChannel of this catalogItem. Applies to [[CatalogItemType]]: | ||
| + | * '''Schedule''' (64) | ||
| + | {{!}}- valign="top" | ||
| + | |||
| + | ! QualityAvailabity | ||
{{!}} int | {{!}} int | ||
| − | {{!}} | + | {{!}} No available |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! ActionUrl | ! ActionUrl | ||
| − | {{!}} | + | {{!}} string |
| − | {{!}} | + | {{!}} No available |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! EpgChannelId | ! EpgChannelId | ||
| − | {{!}} | + | {{!}} string |
| − | + | {{!}} No useful | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | {{!}} | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Distributor | ! Distributor | ||
| − | {{!}} | + | {{!}} string |
| − | {{!}} | + | {{!}} The Distributor of this catalogItem. Applies to [[CatalogItemType]]: |
| + | * '''Movie''' (1) | ||
| + | * '''Serie''' (512) | ||
| + | * '''Season''' (1024) | ||
| + | * '''Episode''' (2048) | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
! [[CommercializationType]] | ! [[CommercializationType]] | ||
| − | {{!}} int | + | {{!}} int (enum) |
{{!}} The commercializationType of this catalogItem. Applies to [[CatalogItemType]]: | {{!}} The commercializationType of this catalogItem. Applies to [[CatalogItemType]]: | ||
* '''Movie''' (1) | * '''Movie''' (1) | ||
| Line 91: | Line 113: | ||
* '''Episode''' (2048) | * '''Episode''' (2048) | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| − | |||
! Trailers | ! Trailers | ||
| Line 100: | Line 121: | ||
* '''Season''' (1024) | * '''Season''' (1024) | ||
* '''Episode''' (2048) | * '''Episode''' (2048) | ||
| + | {{!}}- valign="top" | ||
| + | |||
| + | ! [[TransparentProvider]] | ||
| + | {{!}} int (enum) | ||
| + | {{!}} bgcolor="green" {{!}} '''NEW in 4.0''' Provider (None, HBO, Fox...) of the TransparentCatchup content | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| Line 115: | Line 141: | ||
: "Distributor" : "SimpleXML", | : "Distributor" : "SimpleXML", | ||
: "CommercializationType" : 2, | : "CommercializationType" : 2, | ||
| − | : "Subscriptions" : [10] | + | : "Subscriptions" : [10], |
| + | : "TransparentProvider" : 0, | ||
: "Trailers" : [ | : "Trailers" : [ | ||
: { | : { | ||
| − | : "ID": 6093, | + | :: "ID": 6093, |
| − | : "PlayType": 16, | + | :: "PlayType": 16, |
| − | : "Quality": 3 | + | :: "Quality": 3 |
| − | : } | + | :: } |
: ] | : ] | ||
} | } | ||
| Line 148: | Line 175: | ||
* Included Subscriptions parameter (array of SubscriptionIDs) | * Included Subscriptions parameter (array of SubscriptionIDs) | ||
* Included CommercializationType | * Included CommercializationType | ||
| + | * Included Trailers property | ||
| + | * Removed TrailerPlayReady, TrailerWidevine, TrailerSS, TrailerWVCBS, TrailerHLS, TrailerWVAS, TrailerDTP properties | ||
{{!}} Francisco Milagro | {{!}} Francisco Milagro | ||
| + | {{!}}- valign="top" | ||
| + | |||
| + | ! 4.0 | ||
| + | {{!}} Added field TransparentProvider | ||
| + | {{!}} Jose A. Jiménez | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
Latest revision as of 10:03, 27 June 2016
You are accessing the latest version of this data type, according to /service3.0 (3.2) specification. To access older versions of this object, access ExtraMetatada_3.0
ExtraMetadata is an object with a different extra metadata depending on the CatalogItemType that is being returned.
Members
| Field | Data Type | Description |
|---|---|---|
| ChannelId | string | The LiveChannel ID of this catalogItem. Applies to CatalogItemType:
|
| ChannelTitle | string | The LiveChannel Title of this catalogItem. Applies to CatalogItemType:
|
| ProgramId | string | The ProgramID of this catalogItem. Applies to CatalogItemType:
|
| Stars | float | The Stars of this catalogItem. Applies to CatalogItemType:
|
| Duration | int | The Duration of this catalogItem. Applies to CatalogItemType:
|
| ChildrenCount | int | The number of children of this catalogItem. Applies to CatalogItemType:
|
| CallLetter | string | The CallLetter of the liveChannel of this catalogItem. Applies to CatalogItemType:
|
| ChannelNumber | sting | The ChannelNumber of the liveChannel of this catalogItem. Applies to CatalogItemType:
|
| QualityAvailabity | int | No available |
| ActionUrl | string | No available |
| EpgChannelId | string | No useful |
| Distributor | string | The Distributor of this catalogItem. Applies to CatalogItemType:
|
| CommercializationType | int (enum) | The commercializationType of this catalogItem. Applies to CatalogItemType:
|
| Subscriptions | Array of int | Array of Subscription IDs. Applies to CatalogItemType:
|
| Trailers | Array of Trailers object (ID, Quality and PlayType). | Applies to CatalogItemType:
|
| TransparentProvider | int (enum) | NEW in 4.0 Provider (None, HBO, Fox...) of the TransparentCatchup content |
Example
{
- "Stars" : 5,
- "Audience" : 0,
- "Distributor" : "SimpleXML",
- "CommercializationType" : 2,
- "Subscriptions" : [10],
- "TransparentProvider" : 0,
- "Trailers" : [
- {
- "ID": 6093,
- "PlayType": 16,
- "Quality": 3
- }
- ]
}
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 2.4 | Initial data type implementation | Harley Cabral |
| 3.2 (Neuromancer) |
|
Francisco Milagro |
| 4.0 | Added field TransparentProvider | Jose A. Jiménez |