Companywebcast API Wiki
Navigation
Cwc API Home
PlayerSDK
Meta Service
Getting Started
Creating a client
Methods
Data Types
Understanding Webcast security
Management Service
Getting Started
Creating a client
Methods
Data Types
Quick Search
Advanced Search »
Back
History
MetaService 1.1 : Data Types
These are the Data Types of the Meta Service. ((( *[#WebcastSummary|WebcastSummary] **Code **Languages **CustomerName **ScheduledStart **Status **Title **Hits ***[#Hit|Hit] ****Type ****Description ****Id *[#Webcast|Webcast] **ActualEnd **ActualStart **Annotations ***[#Annotation|Annotation] ****Events *****[#Event|Event] ******Start ******End ****Text **Attachments ***[#Attachment|Attachment] ****ContentType ****Description ****Location ****Size **Code **CustomerName **Description **Id **Language **Languages **[#Location|Location] ***Address ***City ***Coordinates ****Latitude ****Longitude ***CountryCode ***PostalCode ***State ***TimeZoneName **MediaStreams ***[#MediaStream|MediaStream] ****Bitrate ****Dimensions *****Width *****Height ****Id ****Start ****End ****Type ****ContentType ****Description ****Gaps *****[#Gap|Gap] ******Correction ******End ******Offset ******Start ****Location ****Size **ScheduledStart **RegisterUrl **Reference **Slides ***[#Slide|Slide] ****Attachments *****[#Attachment|Attachment] ******ContentType ******Description ******Location ******Size ****Events *****[#Event|Event] ******Start ******End ****Id ****RawText ****Reference **Speakers ***[#Speaker|Speaker] ****Category ****Dob ****Email ****Events *****[#Event|Event] ******Start ******End ****Gender ****Homepage ****Id ****ImageUrl ****Name *****Title *****First *****Middle *****Last ****Phone ****Pob ****Reference ****Role **Status **Tags ***Tag **Title **Topics ***[#Topic|Topic] ****Attachments *****[#Attachment|Attachment] ******ContentType ******Description ******Location ******Size ****Description ****Events *****[#Event|Event] ******Start ******End ****Id ****Reference ****Title ))) [anchor|#WebcastSummary] ====WebcastSummary==== Provides basic information about a Webcast.{BR}{BR} ''WebcastSummary'' has the following properties:{BR}{BR} :''Code'' ::A string. Uniquely identifies a Webcast. :''Languages'' ::A list of language code strings. Indicates the languages this Webcast is available in. :''CustomerName'' ::A string. The name of the person or organization that commissioned the Webcast. :''ScheduledStart'' ::A DateTime/Calendar. UTC representation of the date and time on which the Webcast is scheduled to start. :''Status'' ::An Enumeration value of type ''WebcastStatus''. ::Possible values are: :::''Ready'' ::::Indicates a Webcast has been properly configured and Webcast Player and files are now available. :::''Pre-Live'' ::::Indicates a Webcast is preparing to go live. MediaStreams are now available, or will be very soon. :::''Live'' ::::Indicates a Webcast is live. :::''Pre-Indexed'' ::::Indicates a Webcast is postprocessing files for on demand usage. :::''Indexed'' ::::Indicates a Webcast is available for on demand usage. Downloadable files are now available, or will be very soon. :''Title'' ::A string, the title of the Webcast. :''Hits'' ::A list of ''[#Hit|Hit]'' objects. [anchor|#Hit] ====Hit==== Describes the data item with which a WebcastSearch match was made.{BR}{BR} ''Hit'' has the following properties :{BR}{BR} :''Type'' ::An enumeration of type ''HitType''. ::Possible values are: :::''Customer'' ::::Indicates a (partial) match was made with the CustomerName property of a Webcast. :::''Topic'' ::::Indicates a (partial) match was made with a Topic.Title or Topic.Reference property of a Webcast. :::''Slide'' ::::Indicates a (partial) match was made with a Slide.Text or Slide.Reference property of a Webcast. :::''Speaker'' ::::Indicates a (partial) match was made with a Speaker.Name, Speaker.Reference or Speaker.Category property of a Webcast. :::''Webcast'' ::::Indicates a (partial) match was made with Webcast.Title or Webcast.Reference. :''Description'' ::A string representation of the match that was made. Use this for displaying search results. :''Id'' ::A string. Uniquely identifies a data item or Webcast. Use this to find the data item in a Webcast object. [anchor|#Webcast] ====Webcast==== Provides detailed information about a webcast.{BR}{BR} ''Webcast'' has the following properties:{BR}{BR} :''ActualEnd'' ::A DateTime. UTC representation of the actual date and time on which the Webcast ended. :''ActualStart'' ::A DateTime. UTC representation of the actual date and time on which the Webcast started. :''Annotations'' ::A list of ''[#Annotation|Annotation]'' objects. :''Attachments'' ::A list of ''[#Attachment|Attachment]'' objects. Attachments on the Webcast level contain links to binaries such as media files and slides. :''Code'' ::A string. Uniquely identifies a Webcast. :''CustomerName'' ::A string. The name of the person or organization that commissioned the Webcast. :''Id'' ::A string. Uniquely identifies a Webcast. :''Description'' ::A string. Description of this Webcast. :''Language'' ::A string. Indicates the language version of the Webcast. :''Languages'' ::A list of language code strings. Indicates the languages this Webcast is available in. :''Location'' ::A ''[#Location|Location]'' object. Contains information pertaining to the geographical location of this Webcast. :''MediaStreams'' ::A list of ''[#MediaStream|MediaStream]'' objects. :''ScheduledStart'' ::A DateTime. UTC representation of the date and time on which the Webcast is/was scheduled to start. :''Reference'' ::A string. Custom "free form" field that is controlled through the Management Service. One of its intended uses is to contain identifiers from external data models. :''RegisterUrl'' ::A string. Url to Cwc registration application. :''Slides'' ::A list of ''[#Slide|Slide]'' objects. :''Speakers'' ::A list of ''[#Speaker|Speaker]'' objects. :''Status'' ::An enumeration value of type ''WebcastStatus''.{BR} ::Possible values are: :::''Ready'' ::::Indicates a Webcast has been properly configured and Webcast Player and files are now available. :::''Pre-Live'' ::::Indicates a Webcast is preparing to go live. MediaStreams are now available, or will be very soon. :::''Live'' ::::Indicates a Webcast is live. :::''Pre-Indexed'' ::::Indicates a Webcast is postprocessing files for on demand usage. :::''Indexed'' ::::Indicates a Webcast is available for on demand usage. Downloadable files are now available, or will be very soon. :''Tags'' ::A list of strings. Tags are generally used for indexing purposes. :''Title'' ::A string, the title of the Webcast. :''Topics'' ::A list of ''[#Topic|Topic]'' objects. [anchor|#Annotation] ====Annotation==== An annotation to the Webcast.{BR}{BR} ''Annotation'' has the following properties:{BR}{BR} :''Events'' ::A list of ''[#Event|Event]'' objects. :''Text'' ::A string. The content of the Annotation. [anchor|#Event] ====Event==== Describes the date and time on which a parent object was active.{BR}{BR} ''Event'' has the following properties:{BR}{BR} ::''End'' :::A DateTime. UTC representation of the date and time on which an event ended. ::''Start'' :::A DateTime. UTC representation of the date and time on which an event started. [anchor|#Attachment] ====Attachment==== Contains information about an attached binary.{BR}{BR} ''Attachment'' has the following properties:{BR}{BR} ::''ContentType'' :::A string. Represents the mime-type of the attached binary. ::''Description'' :::A string. Describes the binary. ::''Location'' :::A string. Url of the binary. ::''Size'' :::A long. Size of the binary in bytes. [anchor|#Location] ====Location==== Contains information pertaining to the geographical location of the Webcast.{BR}{BR} ''Location'' has the following properties:{BR}{BR} :''Address'' ::A string. :''City'' ::A string. :''Coordinates'' ::An object with the following properties: :::''Latitude'' ::::A double. :::''Longitude'' ::::A double. :''CountryCode'' ::A string. A 2 character [http://en.wikipedia.org/wiki/ISO_3166-1|ISO 3166-1] country code. :''PostalCode'' ::A string. :''State'' ::A string. :''TimeZoneName'' ::A string. The name of the time zone as defined in [http://en.wikipedia.org/wiki/Zone.tab|Zone.tab]. [anchor|#MediaStream] ====MediaStream==== Contains information about a media stream.{BR}{BR} ''MediaStream'' has the following properties:{BR}{BR} ::''Bitrate'' :::An integer. The bitrate of the media stream in bytes per second. ::''Dimensions'' :::An object with the following properties: ::::''Width'' :::::An integer. The width of the media stream in pixels. Only set for media streams of Type Video. ::::''Height'' :::::An integer. The height of the media stream in pixels. Only set for media streams of Type Video. ::''Id'' :::A string. Uniquely identifies this MediaStream. ::''Start'' :::A DateTime. UTC representation of the date and time on which the media stream starts. ::''End'' :::A DateTime. UTC representation of the date and time on which the media stream ends. ::''Type'' :::An enumeration value of type ''StreamType''. :::Possible values are: ::::''Audio'' ::::''Video'' ::''ContentType'' :::A string. Represents the mime-type of media stream. ::''Description'' :::A string. Describes the media stream. ::''Gaps'' :::A list of ''[#Gap|Gap]'' objects. A gap describes a period that is not available in the MediaStream. ::''Location'' :::A string. Url of the media stream. ::''Size'' :::A long. Size of the stream in bytes. [anchor|#Slide] ====Slide==== Contains information about a slide.{BR}{BR} ''Slide'' has the following properties:{BR}{BR} ::''Attachments'' :::A list of ''[#Attachment|Attachment]'' objects. Attachments on the Slide level contain bitmap representations of a slide in different sizes. ::''Events'' :::A list of ''[#Event|Event]'' objects. ::''Id'' :::A string. Uniquely identifies this Slide. ::''RawText'' :::A string. Text exported from a slide. Use this for indexing purposes only. ::''Reference'' :::A string. Custom "free form" field that is controlled through the Management Service. One of its intended uses is to contain identifiers from external data models. [anchor|#Gap] ====Gap==== Describes a period that is not available in a MediaStream.{BR}{BR} ''Gap'' has the following properties:{BR}{BR} ::''Start'' :::A DateTime. UTC representation of the date and time on which a gap started. ::''End'' :::A DateTime. UTC representation of the date and time on which a gap ended. ::''Offset'' :::A double. The position, in seconds, of the Gap in the MediaStream. This offset is cumulative for preceding Gaps, so further iteration is not required. ::''Correction'' :::A double. The correction, in seconds, that can be added to Offset to compute the actual DateTime of the MediaStream's position. [anchor|#Speaker] ====Speaker==== Contains information about a speaker.{BR}{BR} ''Speaker'' has the following properties:{BR}{BR} ::''Category'' :::A string. Describes political party, department, group etc. ::''Dob'' :::A string. The date of birth of the Speaker. ::''Email'' :::A string. The email address of the Speaker. ::''Events'' :::A list of ''[#Event|Event]'' objects. ::''Gender'' :::An enumeration that can have one of the following properties: ::::''Unknown'' ::::''Male'' ::::''Female'' ::''Homepage'' :::A string. A Url to the home page of the Speaker. ::''Id'' :::A string. Uniquely identifies this Speaker. Note that in the Company Webcast model Speakers are cloned for each Webcast, and therefor do not have a consistent Id across different Webcasts. To identify a Speaker across different Webcasts, use their Name or Reference properties. ::''ImageUrl'' :::A string. A Url to a picture of the Speaker. ::''Name'' :::An object with the following properties:{BR} ::::''Title'' :::::A string. The title of the Speaker. ::::''First'' :::::A string. The first name of the Speaker. ::::''Middle'' :::::A string. The middle name of the Speaker. ::::''Last'' :::::A string. The last name of the Speaker. ::''Phone'' :::A string. The phone number of the Speaker. ::''Pob'' :::A string. The place of birth of the Speaker. ::''Reference'' :::A string. Custom "free form" field that is controlled through the Management Service. One of its intended uses is to contain identifiers from external data models. ::''Role'' :::A string. The role of the Speaker. [anchor|#Topic] ====Topic==== Contains information about a topic.{BR}{BR} ''Topic'' has the following properties:{BR}{BR} ::''Attachments'' :::A list of ''[#Attachment|Attachment]'' objects. ::''Description'' :::A string. Description of this Topic. ::''Events'' :::A list of ''[#Event|Event]'' objects. ::''Id'' :::A string. Uniquely identifies this Topic. ::''Reference'' :::A string. Custom "free form" field that is controlled through the Management Service. One of its intended uses is to contain identifiers from external data models. ::''Tags'' :::A list of strings. Tags are generally used for indexing purposes. ::''Title'' :::A string. The title of the Topic.