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.0 : Data returned
The information on this page is basically a duplicate of the MetaService XML schema , so you would get the same information by looking at the [https://services.companywebcast.com/meta/metaservice.svc?wsdl|MetaService WSDL file]. ((( '''WebcastSearch returns:'''{BR} *[#WebcastSearchResult|WebcastSearchResult] *[#WebcastSummaries|WebcastSummaries] **[#WebcastSummary|WebcastSummary] ***Code ***Languages ***OwnerName ***PlannedStart ***Status ***Title '''WebcastGet returns:'''{BR} *[#WebcastGetResult|WebcastGetResult] *[#Webcast|Webcast] **ActualEnd **ActualStart **Annotations ***[#Annotation|Annotation] ****Events *****[#Event|Event] ******Start ******End ****Text **Attachments ***[#Attachment|Attachment] ****ContentType ****Description ****Location ****Size **Code **Language **Languages **MediaStreams ***[#MediaStream|MediaStream] ****Bitrate ****Dimensions *****Width *****Height ****Start ****End ****Type ****ContentType ****Description ****Gaps *****[#Gap|Gap] ******Correction ******End ******Offset ******Start ****Location ****Size **OwnerName **PlannedStart **RegisterUrl **Slides ***[#Slide|Slide] ****Attachments *****[#Attachment|Attachment] ******ContentType ******Description ******Location ******Size ****Events *****[#Event|Event] ******Start ******End ****RawText **Speakers ***[#Speaker|Speaker] ****Category ****Dob ****Email ****Events *****[#Event|Event] ******Start ******End ****Homepage ****Name *****First *****Middle *****Last ****Phone ****Pob ****Role **Status **Title **Topics ***[#Topic|Topic] ****Attachments *****[#Attachment|Attachment] ******ContentType ******Description ******Location ******Size ****Events *****[#Event|Event] ******Start ******End ****Title ))) [anchor|#WebcastSearchResult] ====WebcastSearchResult==== An integer that indicates the success or failure of your request.{BR}{BR} Possible values are :{BR}{BR} 0 = success{BR} {BR} Positive (= client error):{BR} 2 = Page size exceeds 100{BR} 3 = Not authorized{BR} {BR} Negative (= server error):{BR} -1 = Server error{BR} -2 = Service temporarily offline [anchor|#WebcastSummaries] ====WebcastSummaries==== A list of ''[#WebcastSummary|WebcastSummary]'' objects. [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. :''OwnerName'' ::A string. The name of the person or organization that commissioned the Webcast. :''PlannedStart'' ::A DateTime/Calendar. UTC representation of the date and time on which the Webcast is planned 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. [anchor|#WebcastGetResult] ====WebcastGetResult==== An integer that indicates the success or failure of your request.{BR}{BR} Possible values are :{BR}{BR} 0 = success{BR} {BR} Positive (= client error):{BR} 1 = Invalid Webcast Code{BR} 3 = Not authorized{BR} {BR} Negative (= server error):{BR} -1 = Server error{BR} -2 = Service temporarily offline [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. :''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. :''MediaStreams'' ::A list of ''[#MediaStream|MediaStream]'' objects. :''OwnerName'' ::A string. The name of the person or organization that commissioned the Webcast. :''PlannedStart'' ::A DateTime. UTC representation of the date and time on which the Webcast is/was planned to start. :''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. :''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|#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. ::''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. ::''RawText'' :::A string. Text exported from a slide. Use this for indexing purposes only. [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. ::''Homepage'' :::A string. A Url to the home page of the Speaker. ::''Name'' :::An object with the following properties:{BR} ::::''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. ::''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. ::''Events'' :::A list of ''[#Event|Event]'' objects. ::''Title'' :::A string. The title of the Topic.