Download URL:
http://bbvideo.spbu.ru:443/api_v3/index.php/service/schema/action/serve/type/cuePoint.ingestAPI/name/cuePoint.ingestAPI.xsd
Version: 1.0
<xs:schema version="1.0">
<xs:complexType name="T_scenes">
<xs:sequence>
<xs:element ref="scene" minOccurs="1" maxOccurs="unbounded">
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="T_scene" abstract="true">
<xs:sequence>
<xs:element name="sceneStartTime" minOccurs="1" maxOccurs="1" type="xs:time">
</xs:element>
<xs:element name="tags" minOccurs="0" maxOccurs="1" type="T_tags">
</xs:element>
</xs:sequence>
<xs:attribute name="sceneId" use="optional">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="systemName" use="optional">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="120"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="entryId" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
<xs:complexType name="T_tags">
<xs:sequence>
<xs:element name="tag" minOccurs="1" maxOccurs="unbounded">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="scenes" type="T_scenes">
</xs:element>
<xs:element name="scene" type="T_scene">
</xs:element>
<xs:element name="scene-extension"></xs:element>
<xs:complexType name="T_customData">
<xs:sequence>
<xs:any namespace="##local" processContents="skip" minOccurs="1" maxOccurs="1">
</xs:any>
</xs:sequence>
<xs:attribute name="metadataId" use="optional" type="xs:int">
</xs:attribute>
<xs:attribute name="metadataProfile" use="optional" type="xs:string">
</xs:attribute>
<xs:attribute name="metadataProfileId" use="optional" type="xs:int">
</xs:attribute>
</xs:complexType>
<xs:element name="scene-customData" type="T_customData" substitutionGroup="scene-extension">
</xs:element>
<xs:complexType name="T_scene_adCuePoint">
<xs:complexContent>
<xs:extension base="T_scene">
<xs:sequence>
<xs:element name="sceneEndTime" minOccurs="0" maxOccurs="1" type="xs:time">
</xs:element>
<xs:element name="sceneTitle" minOccurs="0" maxOccurs="1">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="sourceUrl" minOccurs="0" maxOccurs="1" type="xs:string">
</xs:element>
<xs:element name="adType" minOccurs="1" maxOccurs="1" type="KalturaAdType">
</xs:element>
<xs:element name="protocolType" minOccurs="1" maxOccurs="1" type="KalturaAdProtocolType">
</xs:element>
<xs:element ref="scene-extension" minOccurs="0" maxOccurs="unbounded"></xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="scene-ad-cue-point" type="T_scene_adCuePoint" substitutionGroup="scene">
</xs:element>
<xs:complexType name="T_scene_codeCuePoint">
<xs:complexContent>
<xs:extension base="T_scene">
<xs:sequence>
<xs:element name="sceneEndTime" minOccurs="0" maxOccurs="1" type="xs:time">
</xs:element>
<xs:element name="code" minOccurs="0" maxOccurs="1">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="description" minOccurs="0" maxOccurs="1" type="xs:string">
</xs:element>
<xs:element ref="scene-extension" minOccurs="0" maxOccurs="unbounded"></xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="scene-code-cue-point" type="T_scene_codeCuePoint" substitutionGroup="scene">
</xs:element>
<xs:complexType name="T_scene_annotation">
<xs:complexContent>
<xs:extension base="T_scene">
<xs:sequence>
<xs:element name="sceneEndTime" minOccurs="1" maxOccurs="1" type="xs:time">
</xs:element>
<xs:element name="sceneText" minOccurs="0" maxOccurs="1" type="xs:string">
</xs:element>
<xs:choice minOccurs="0" maxOccurs="1">
<xs:element name="parent" minOccurs="1" maxOccurs="1">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="120"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="parentId" minOccurs="1" maxOccurs="1">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:choice>
<xs:element ref="scene-extension" minOccurs="0" maxOccurs="unbounded"></xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="scene-annotation" type="T_scene_annotation" substitutionGroup="scene">
</xs:element>
<xs:simpleType name="KalturaAdType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"></xs:enumeration>
<xs:enumeration value="2"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="KalturaDynamicEnum">
<xs:restriction base="xs:string">
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="KalturaAdProtocolType">
<xs:restriction base="xs:string">
<xs:enumeration value="0"></xs:enumeration>
<xs:enumeration value="1"></xs:enumeration>
<xs:enumeration value="2"></xs:enumeration>
<xs:enumeration value="3"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:schema>
scenes element (T_scenes)
Cue points wrapperSub-Elements
| Element Name |
Description |
Required |
Maximum Appearances |
Type |
Restrictions |
| scene |
Cue point element
|
Yes |
Unbounded |
|
|
XML Example
<scenes>
<scene-ad-cue-point entryId="{entry id}" systemName="MY_AD_CUE_POINT_SYSTEM_NAME">...</scene-ad-cue-point>
<scene-annotation entryId="{entry id}" systemName="MY_ANNOTATION_PARENT_SYSTEM_NAME">...</scene-annotation>
<scene-annotation entryId="{entry id}">...</scene-annotation>
<scene-code-cue-point entryId="{entry id}">...</scene-code-cue-point>
<scene-thumb-cue-point entryId="{entry id}">...</scene-thumb-cue-point>
</scenes>
scene element (abstract T_scene)
Base cue point element
Is abstract and cannot be used
Use the extended elements only
Attributes
| Attribute Name |
Description |
Required |
Type |
Restrictions |
| sceneId |
ID of cue point to which actions (update/delete) can be applied
|
No |
string |
Maximum length: 250 characters
|
| systemName |
System name of cue point to which actions (update/delete) can be applied
|
No |
string |
Maximum length: 120 characters
|
| entryId |
ID of entry to associate the cue point with
|
Yes |
string |
Maximum length: 20 characters
|
Sub-Elements
| Element Name |
Description |
Required |
Maximum Appearances |
Type |
Restrictions |
| sceneStartTime |
Cue point start time
|
Yes |
1 |
time |
|
| tags |
Cue point searchable keywords
|
No |
1 |
|
|
Extended elements
- scene-ad-cue-point
- scene-code-cue-point
- scene-annotation
scene-customData element (T_customData)
XML for custom metadataAttributes
| Attribute Name |
Description |
Required |
Type |
Restrictions |
| metadataId |
Id of the custom metadata object
|
No |
int |
|
| metadataProfile |
Custom metadata schema profile system name
|
No |
string |
|
| metadataProfileId |
Custom metadata schema profile id
|
No |
int |
|
Sub-Elements
| Element Name |
Description |
Required |
Maximum Appearances |
Type |
Restrictions |
| [Any element] |
Custom metadata XML according to schema profile
|
Yes |
1 |
any type |
|
XML Example
<scene-ad-cue-point entryId="{entry id}">
<sceneStartTime>00:00:05</sceneStartTime>
<sceneTitle>my ad title</sceneTitle>
<sourceUrl>http://source.to.my/ad.xml</sourceUrl>
<adType>1</adType>
<protocolType>1</protocolType>
<scene-customData metadataProfile="MY_AD_METADATA_PROFILE_SYSTEM_NAME">
<metadata>
<adData>my ad custom data</adData>
</metadata>
</scene-customData>
</scene-ad-cue-point>
scene-ad-cue-point element (T_scene_adCuePoint)
Single ad cue point elementSub-Elements
| Element Name |
Description |
Required |
Maximum Appearances |
Type |
Restrictions |
| Extended from T_scene
|
| sceneStartTime |
Cue point start time
|
Yes |
1 |
time |
|
| tags |
Cue point searchable keywords
|
No |
1 |
|
|
|
| sceneEndTime |
Cue point end time
|
No |
1 |
time |
|
| sceneTitle |
Textual title
|
No |
1 |
string |
Maximum length: 250 characters
|
| sourceUrl |
The URL of the ad XML
|
No |
1 |
string |
|
| adType |
Indicates the ad type
|
Yes |
1 |
KalturaAdType |
|
| protocolType |
Indicates the ad protocol type
|
Yes |
1 |
KalturaAdProtocolType |
|
| Extensions: |
|
| scene-customData |
XML for custom metadata
|
No |
Unbounded |
|
|
XML Example
<scene-ad-cue-point sceneId="{scene id}" entryId="{entry id}" systemName="MY_AD_CUE_POINT_SYSTEM_NAME">
<sceneStartTime>00:00:05</sceneStartTime>
<tags>
<tag>sample</tag>
<tag>my_tag</tag>
</tags>
<sceneTitle>my ad title</sceneTitle>
<sourceUrl>http://source.to.my/ad.xml</sourceUrl>
<adType>1</adType>
<protocolType>1</protocolType>
</scene-ad-cue-point>
scene-code-cue-point element (T_scene_codeCuePoint)
Single code cue point elementSub-Elements
| Element Name |
Description |
Required |
Maximum Appearances |
Type |
Restrictions |
| Extended from T_scene
|
| sceneStartTime |
Cue point start time
|
Yes |
1 |
time |
|
| tags |
Cue point searchable keywords
|
No |
1 |
|
|
|
| sceneEndTime |
Cue point end time
|
No |
1 |
time |
|
| code |
Textual code
|
No |
1 |
string |
Maximum length: 250 characters
|
| description |
Free text description
|
No |
1 |
string |
|
| Extensions: |
|
| scene-customData |
XML for custom metadata
|
No |
Unbounded |
|
|
XML Example
<scene-code-cue-point sceneId="{scene id}" entryId="{entry id}">
<sceneStartTime>00:00:05.3</sceneStartTime>
<tags>
<tag>sample</tag>
<tag>my_tag</tag>
</tags>
<code>MY_CODE</code>
<description>my code cue point description</description>
</scene-code-cue-point>
scene-annotation element (T_scene_annotation)
Single annotation elementSub-Elements
| Element Name |
Description |
Required |
Maximum Appearances |
Type |
Restrictions |
| Extended from T_scene
|
| sceneStartTime |
Cue point start time
|
Yes |
1 |
time |
|
| tags |
Cue point searchable keywords
|
No |
1 |
|
|
|
| sceneEndTime |
Cue point end time
|
Yes |
1 |
time |
|
| sceneText |
Free text description
|
No |
1 |
string |
|
| Choice |
|
No |
1 |
|
One of the following choices
|
| parent |
Option 1 |
System name of the parent annotation
|
Yes |
1 |
string |
Maximum length: 120 characters
|
| parentId |
Option 2 |
ID of the parent annotation
|
Yes |
1 |
string |
Maximum length: 250 characters
|
| Extensions: |
|
| scene-customData |
XML for custom metadata
|
No |
Unbounded |
|
|
Single annotation example
<scene-annotation entryId="{entry id}">
<sceneStartTime>00:00:05.3</sceneStartTime>
<tags>
<tag>sample</tag>
<tag>my_tag</tag>
</tags>
<sceneEndTime>00:00:10</sceneEndTime>
<sceneText>my annotation</sceneText>
</scene-annotation>
Multiple related annotations example
<scene-annotation entryId="{entry id}" systemName="MY_ANNOTATION_PARENT_SYSTEM_NAME">
<sceneStartTime>00:00:05.3</sceneStartTime>
<tags>
<tag>sample</tag>
<tag>my_tag</tag>
</tags>
<sceneEndTime>00:00:10</sceneEndTime>
<sceneText>my annotation parent</sceneText>
</scene-annotation>
<scene-annotation entryId="{entry id}">
<sceneStartTime>00:00:05.3</sceneStartTime>
<tags>
<tag>sample</tag>
<tag>my_tag</tag>
</tags>
<sceneEndTime>00:00:10</sceneEndTime>
<sceneText>my annotation child</sceneText>
<parent>MY_ANNOTATION_PARENT_SYSTEM_NAME</parent>
</scene-annotation>