Difference between revisions of "ExtraMetadata"

From Gvp-public
Jump to navigation Jump to search
 
(22 intermediate revisions by 3 users not shown)
Line 2: Line 2:
  
 
{{Api_DataType_Spec
 
{{Api_DataType_Spec
−
|Description=ExtraMetadata is a Dictionary with a different values for content.
+
|Description=ExtraMetadata is an object with a different extra metadata depending on the [[CatalogItemType]] that is being returned.  
  
 
|Members=
 
|Members=
Line 12: Line 12:
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! KEY
+
! ChannelId
−
{{!}} String
+
{{!}} string
−
{{!}}  
+
{{!}} The LiveChannel ID of this catalogItem. Applies to [[CatalogItemType]]:
 +
* '''Schedule''' (64)
 +
{{!}}- valign="top"
 +
 
 +
! ChannelTitle
 +
{{!}} string
 +
{{!}} The LiveChannel Title of this catalogItem. Applies to [[CatalogItemType]]:
 +
* '''Schedule''' (64)
 +
{{!}}- valign="top"
 +
 
 +
! ProgramId
 +
{{!}} string
 +
{{!}} The ProgramID of this catalogItem. Applies to [[CatalogItemType]]:
 +
* '''Schedule''' (64)
 +
{{!}}- valign="top"
 +
 
 +
! Stars
 +
{{!}} float
 +
{{!}} The Stars of this catalogItem. Applies to [[CatalogItemType]]:
 +
* '''Movie''' (1)
 +
* '''Serie''' (512)
 +
* '''Season''' (1024)
 +
* '''Episode''' (2048)
 +
{{!}}- valign="top"
 +
 
 +
! Duration
 +
{{!}} int
 +
{{!}} The Duration of this catalogItem. Applies to [[CatalogItemType]]:
 +
* '''Movie''' (1)
 +
* '''Schedule''' (64)
 +
* '''Serie''' (512)
 +
* '''Season''' (1024)
 +
* '''Episode''' (2048)
 +
{{!}}- valign="top"
 +
 
 +
 
 +
! ChildrenCount
 +
{{!}} int
 +
{{!}} The number of children of this catalogItem. Applies to [[CatalogItemType]]:
 +
* '''Movie''' (1)
 +
* '''Serie''' (512)
 +
* '''Season''' (1024)
 +
* '''Episode''' (2048)
 +
{{!}}- valign="top"
 +
 
 +
! CallLetter
 +
{{!}} string
 +
{{!}} {{!}} The CallLetter of the liveChannel of this catalogItem. Applies to [[CatalogItemType]]:
 +
* '''Schedule''' (64)
 +
{{!}}- valign="top"
 +
 
 +
! ChannelNumber
 +
{{!}} sting
 +
{{!}} The ChannelNumber of the liveChannel of this catalogItem. Applies to [[CatalogItemType]]:
 +
* '''Schedule''' (64)
 +
{{!}}- valign="top"
 +
 
 +
! QualityAvailabity
 +
{{!}} int
 +
{{!}} No available
 +
{{!}}- valign="top"
 +
 
 +
! ActionUrl
 +
{{!}} string
 +
{{!}} No available
 +
{{!}}- valign="top"
 +
 
 +
! EpgChannelId
 +
{{!}} string
 +
{{!}} No useful
 +
{{!}}- valign="top"
 +
 
 +
! Distributor
 +
{{!}} string
 +
{{!}} The Distributor of this catalogItem. Applies to [[CatalogItemType]]:
 +
* '''Movie''' (1)
 +
* '''Serie''' (512)
 +
* '''Season''' (1024)
 +
* '''Episode''' (2048)
 +
{{!}}- valign="top"
 +
 
 +
! [[CommercializationType]]
 +
{{!}} int (enum)
 +
{{!}} The commercializationType of this catalogItem. Applies to [[CatalogItemType]]:
 +
* '''Movie''' (1)
 +
* '''Serie''' (512)
 +
* '''Season''' (1024)
 +
* '''Episode''' (2048)
 +
{{!}}- valign="top"
 +
 
 +
! Subscriptions
 +
{{!}} Array of int
 +
{{!}} Array of Subscription IDs. Applies to [[CatalogItemType]]:
 +
* '''Movie''' (1)
 +
* '''LiveChannel''' (256)
 +
* '''Serie''' (512)
 +
* '''Season''' (1024)
 +
* '''Episode''' (2048)
 +
{{!}}- valign="top"
 +
 
 +
! Trailers
 +
{{!}} Array of Trailers object (ID, Quality and PlayType).
 +
{{!}} Applies to [[CatalogItemType]]:
 +
* '''Movie''' (1)
 +
* '''Serie''' (512)
 +
* '''Season''' (1024)
 +
* '''Episode''' (2048)
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! Value
+
! [[TransparentProvider]]
−
{{!}} String
+
{{!}} int (enum)
−
{{!}}  
+
{{!}} bgcolor="green" {{!}} '''NEW in 4.0''' Provider (None, HBO, Fox...) of the TransparentCatchup content
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
{{!}}}
 
{{!}}}
 +
 +
  
  
 
|Example=
 
|Example=
 +
  
 
{
 
{
−
:       "KEY": "VALUE"
+
: "Stars" : 5,               
−
}
+
: "Audience" : 0,               
 +
: "Distributor" : "SimpleXML",               
 +
: "CommercializationType" : 2,               
 +
: "Subscriptions" : [10],
 +
: "TransparentProvider" : 0,
 +
: "Trailers" : [
 +
:          {
 +
::            "ID": 6093,
 +
::            "PlayType": 16,
 +
::            "Quality": 3
 +
::            }
 +
:    ]
 +
}  
  
  
Line 47: Line 168:
 
{{!}} Initial data type implementation
 
{{!}} Initial data type implementation
 
{{!}} Harley Cabral
 
{{!}} Harley Cabral
 +
{{!}}- valign="top"
 +
 +
! 3.2 (Neuromancer)
 +
{{!}}
 +
* Refactoring to include different data types instead of String
 +
* Included Subscriptions parameter (array of SubscriptionIDs)
 +
* Included CommercializationType
 +
* Included Trailers property
 +
* Removed TrailerPlayReady, TrailerWidevine, TrailerSS, TrailerWVCBS, TrailerHLS, TrailerWVAS, TrailerDTP properties
 +
{{!}} 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

Infobox info icon.svg.png

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:
  • Schedule (64)
ChannelTitle string The LiveChannel Title of this catalogItem. Applies to CatalogItemType:
  • Schedule (64)
ProgramId string The ProgramID of this catalogItem. Applies to CatalogItemType:
  • Schedule (64)
Stars float The Stars of this catalogItem. Applies to CatalogItemType:
  • Movie (1)
  • Serie (512)
  • Season (1024)
  • Episode (2048)
Duration int The Duration of this catalogItem. Applies to CatalogItemType:
  • Movie (1)
  • Schedule (64)
  • Serie (512)
  • Season (1024)
  • Episode (2048)
ChildrenCount int The number of children of this catalogItem. Applies to CatalogItemType:
  • Movie (1)
  • Serie (512)
  • Season (1024)
  • Episode (2048)
CallLetter string The CallLetter of the liveChannel of this catalogItem. Applies to CatalogItemType:
  • Schedule (64)
ChannelNumber sting The ChannelNumber of the liveChannel of this catalogItem. Applies to CatalogItemType:
  • Schedule (64)
QualityAvailabity int No available
ActionUrl string No available
EpgChannelId string No useful
Distributor string The Distributor of this catalogItem. Applies to CatalogItemType:
  • Movie (1)
  • Serie (512)
  • Season (1024)
  • Episode (2048)
CommercializationType int (enum) The commercializationType of this catalogItem. Applies to CatalogItemType:
  • Movie (1)
  • Serie (512)
  • Season (1024)
  • Episode (2048)
Subscriptions Array of int Array of Subscription IDs. Applies to CatalogItemType:
  • Movie (1)
  • LiveChannel (256)
  • Serie (512)
  • Season (1024)
  • Episode (2048)
Trailers Array of Trailers object (ID, Quality and PlayType). Applies to CatalogItemType:
  • Movie (1)
  • Serie (512)
  • Season (1024)
  • Episode (2048)
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)
  • Refactoring to include different data types instead of String
  • Included Subscriptions parameter (array of SubscriptionIDs)
  • Included CommercializationType
  • Included Trailers property
  • Removed TrailerPlayReady, TrailerWidevine, TrailerSS, TrailerWVCBS, TrailerHLS, TrailerWVAS, TrailerDTP properties
 Francisco Milagro
4.0 Added field TransparentProvider Jose A. Jiménez


See also

Retrieved from "https://wikis.tid.es/gvp-public/index.php?title=ExtraMetadata&oldid=1829"