Kaltura - XML Schema Documentation

Download URL: http://api.frp2.ovp.kaltura.com/api_v3/index.php/service/schema/action/serve/type/cuePoint.serveAPI/name/cuePoint.serveAPI.xsd
Version: 1.0

<xs:schema version="1.0">
<xs:complexType name="T_scenes">
<xs:sequence>
<xs:element ref="scene" minOccurs="0" 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="userId" minOccurs="0" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="tags" minOccurs="0" maxOccurs="1" type="T_tags"> </xs:element>
</xs:sequence>

<xs:attribute name="sceneId" use="required">

<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_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_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:element name="parent" minOccurs="0" 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="0" maxOccurs="1">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</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-annotation" type="T_scene_annotation" 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_thumbCuePoint">
<xs:complexContent>
<xs:extension base="T_scene">
<xs:sequence>
<xs:element name="title" minOccurs="1" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="description" minOccurs="1" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="subType" minOccurs="0" maxOccurs="1" type="KalturaThumbCuePointSubType"> </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-thumb-cue-point" type="T_scene_thumbCuePoint" substitutionGroup="scene"> </xs:element>

<xs:complexType name="T_scene_questionCuePoint">
<xs:complexContent>
<xs:extension base="T_scene">
<xs:sequence>
<xs:element name="question" minOccurs="1" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="hint" minOccurs="0" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="explanation" minOccurs="0" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="optionalAnswers" minOccurs="0" maxOccurs="unbounded" type="T_optionalAnswers"></xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

<xs:complexType name="T_optionalAnswers">
<xs:sequence>
<xs:element ref="optionalAnswer" maxOccurs="unbounded" minOccurs="0"> </xs:element>
</xs:sequence>
</xs:complexType>

<xs:complexType name="T_optionalAnswer">
<xs:sequence>
<xs:element name="key" maxOccurs="1" minOccurs="0" type="xs:string"> </xs:element>

<xs:element name="text" maxOccurs="1" minOccurs="0" type="xs:string"> </xs:element>

<xs:element name="weight" maxOccurs="1" minOccurs="0" type="xs:float"> </xs:element>

<xs:element name="isCorrect" maxOccurs="1" minOccurs="0" type="xs:int"> </xs:element>
</xs:sequence>
</xs:complexType>

<xs:element name="optionalAnswers" type="T_optionalAnswers"> </xs:element>

<xs:element name="optionalAnswer" type="T_optionalAnswer"> </xs:element>

<xs:element name="scene-question-cue-point" type="T_scene_questionCuePoint" substitutionGroup="scene"> </xs:element>

<xs:complexType name="T_scene_answerCuePoint">
<xs:complexContent>
<xs:extension base="T_scene">
<xs:sequence>
<xs:element name="answerKey" minOccurs="1" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="quizUserEntryId" minOccurs="1" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="parentId" minOccurs="1" maxOccurs="1" type="xs:string"> </xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

<xs:element name="scene-answer-cue-point" type="T_scene_answerCuePoint" substitutionGroup="scene"> </xs:element>

<xs:complexType name="T_scene_sessionCuePoint">
<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 ref="scene-extension" minOccurs="0" maxOccurs="unbounded"></xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

<xs:element name="scene-session-cue-point" type="T_scene_sessionCuePoint" substitutionGroup="scene"> </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="required" type="xs:int"> </xs:attribute>

<xs:attribute name="metadataVersion" use="required" type="xs:int"> </xs:attribute>

<xs:attribute name="metadataProfile" use="optional" type="xs:string"> </xs:attribute>

<xs:attribute name="metadataProfileId" use="required" type="xs:int"> </xs:attribute>

<xs:attribute name="metadataProfileName" use="optional" type="xs:string"> </xs:attribute>

<xs:attribute name="metadataProfileVersion" use="required" type="xs:int"> </xs:attribute>
</xs:complexType>

<xs:element name="scene-customData" type="T_customData" substitutionGroup="scene-extension"> </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:simpleType name="KalturaThumbCuePointSubType">

<xs:restriction base="xs:int">
<xs:enumeration value="1"></xs:enumeration>

<xs:enumeration value="2"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:schema>

scenes element (T_scenes)
Cue points wrapper

Sub-Elements

Element Name		Description	Required	Maximum Appearances	Type	Restrictions
scene		Cue point element	No	Unbounded

XML Example

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	Unique auto generated id of the cue point	Yes	string	Maximum length: 250 characters
systemName	Unique (per entry) user identifier of the cue point	No	string	Maximum length: 120 characters
entryId	ID of entry that is associated with cue point	Yes	string	Maximum length: 20 characters

Sub-Elements

Element Name	Description	Required	Maximum Appearances	Type
sceneStartTime	Cue point start time	Yes	1	time
userId	User ID of cue point's owner	No	1	string
tags	Cue point searchable keywords	No	1

Extended elements

scene-ad-cue-point
scene-annotation
scene-code-cue-point
scene-thumb-cue-point
scene-question-cue-point
scene-answer-cue-point
scene-session-cue-point

scene-ad-cue-point element (T_scene_adCuePoint)
Single ad cue point element

Sub-Elements

Element Name	Description	Required	Maximum Appearances	Type	Restrictions
Extended from T_scene
sceneStartTime	Cue point start time	Yes	1	time
userId	User ID of cue point's owner	No	1	string
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-annotation element (T_scene_annotation)
Single annotation element

Sub-Elements

Element Name	Description	Required	Maximum Appearances	Type	Restrictions
Extended from T_scene
sceneStartTime	Cue point start time	Yes	1	time
userId	User ID of cue point's owner	No	1	string
tags	Cue point searchable keywords	No	1

sceneEndTime	Cue point end time	Yes	1	time
sceneText	Free text description	No	1	string
parent	System name of the parent annotation	No	1	string	Maximum length: 120 characters
parentId	ID of the parent annotation	No	1	string	Maximum length: 250 characters
Extensions:
scene-customData	XML for custom metadata	No	Unbounded

XML Example

<scene-annotation sceneId="{scene id}" 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>

scene-code-cue-point element (T_scene_codeCuePoint)
Single code cue point element

Sub-Elements

Element Name	Description	Required	Maximum Appearances	Type	Restrictions
Extended from T_scene
sceneStartTime	Cue point start time	Yes	1	time
userId	User ID of cue point's owner	No	1	string
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-thumb-cue-point element (T_scene_thumbCuePoint)
Single thumb cue point element

Sub-Elements

Element Name	Description	Required	Maximum Appearances	Type
Extended from T_scene
sceneStartTime	Cue point start time	Yes	1	time
userId	User ID of cue point's owner	No	1	string
tags	Cue point searchable keywords	No	1

title		Yes	1	string
description		Yes	1	string
subType	Indicates the thumb cue point sub type 1 = Slide 2 = Chapter	No	1	KalturaThumbCuePointSubType
Extensions:
scene-customData	XML for custom metadata	No	Unbounded

XML Example

<scene-thumb-cue-point sceneId="{scene id}" entryId="{entry id}">
<sceneStartTime>00:00:05.3</sceneStartTime>

<tags>
<tag>my_tag</tag>
</tags>
</scene-thumb-cue-point>

optionalAnswers element (T_optionalAnswers)
Wrapper element holding multiple answer elements

Sub-Elements

Element Name		Description	Required	Maximum Appearances	Type	Restrictions
optionalAnswer		Single optional answer element	No	Unbounded

XML Example

optionalAnswer element (T_optionalAnswer)
Single wrapper element for optional answer

Sub-Elements

Element Name	Required	Maximum Appearances	Type
key	No	1	string
text	No	1	string
weight	No	1	float
isCorrect	No	1	int

XML Example

<optionalAnswer>
<text>tesAnswer1</text>

<weight>1</weight>

<isCorrect>1</isCorrect>
</optionalAnswer>

scene-question-cue-point element (T_scene_questionCuePoint)
Single question cue point element

Sub-Elements

Element Name	Description	Required	Maximum Appearances	Type
Extended from T_scene
sceneStartTime	Cue point start time	Yes	1	time
userId	User ID of cue point's owner	No	1	string
tags	Cue point searchable keywords	No	1

question		Yes	1	string
hint		No	1	string
explanation		No	1	string
optionalAnswers		No	Unbounded

XML Example

<scene-question-cue-point sceneId="{scene id}" entryId="{entry id}">
<sceneStartTime>00:00:05.3</sceneStartTime>

<tags>
<tag>my_tag</tag>
</tags>
</scene-question-cue-point>

scene-answer-cue-point element (T_scene_answerCuePoint)
Single answer cue point element

Sub-Elements

Element Name	Description	Required	Maximum Appearances	Type
Extended from T_scene
sceneStartTime	Cue point start time	Yes	1	time
userId	User ID of cue point's owner	No	1	string
tags	Cue point searchable keywords	No	1

answerKey		Yes	1	string
quizUserEntryId		Yes	1	string
parentId	ID of the parent questionCuePoint	Yes	1	string

XML Example

<scene-answer-cue-point sceneId="{scene id}" entryId="{entry id}">
<sceneStartTime>00:00:05.3</sceneStartTime>

<tags>
<tag>my_tag</tag>
</tags>
</scene-answer-cue-point>

scene-session-cue-point element (T_scene_sessionCuePoint)
Single session cue point element

Sub-Elements

Element Name	Description	Required	Maximum Appearances	Type	Restrictions
Extended from T_scene
sceneStartTime	Cue point start time	Yes	1	time
userId	User ID of cue point's owner	No	1	string
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
Extensions:
scene-customData	XML for custom metadata	No	Unbounded

XML Example

<scene-session-cue-point sceneId="{scene id}" entryId="{entry id}" systemName="MY_SESSION_CUE_POINT_SYSTEM_NAME">
<sceneStartTime>00:00:05</sceneStartTime>

<tags>
<tag>sample</tag>

<tag>my_tag</tag>
</tags>

<sceneTitle>my session title</sceneTitle>

<sourceUrl>http://source.to.my/session.xml</sourceUrl>
</scene-session-cue-point>

scene-customData element (T_customData)
XML for custom metadata

Attributes

Attribute Name	Description	Required	Type
metadataId	Id of the custom metadata object	Yes	int
metadataVersion	Custom metadata version	Yes	int
metadataProfile	Custom metadata schema profile system name	No	string
metadataProfileId	Custom metadata schema profile id	Yes	int
metadataProfileName	Custom metadata schema profile name	No	string
metadataProfileVersion	Custom metadata schema profile version	Yes	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 metadataId="{metadata id}" metadataVersion="1" metadataProfile="MY_METADATA_PROFILE_SYSTEM_NAME}" metadataProfileId="{metadata profile id}" metadataProfileName="my metadata profile" metadataProfileVersion="1">
<metadata>
<adData>my ad custom data</adData>
</metadata>
</scene-customData>
</scene-ad-cue-point>

General

Schemas