Companywebcast API Wiki

Page History: MetaService 1.0 : Data returned

Compare Page Revisions



« Older Revision - Back to Page History - Newer Revision »


Page Revision: 2009/05/24 21:27


The information on this page a basically a duplicate of the XML schema of the MetaService, so you would get the same information by looking at the MetaService WSDL file.

WebcastSearch returns:

WebcastGet returns:
  • WebcastGetResult
  • Webcast
    • ActualEnd
    • ActualStart
    • Annotations
    • Attachments
    • Id
    • Language
    • Languages
    • MediaStreams
      • MediaStream
        • Bitrate
        • Dimensions
          • Width
          • Height
        • Start
        • End
        • Type
        • ContentType
        • Description
        • Location
        • Size
    • OwnerName
    • PlannedStart
    • RegisterUrl
    • Slides
    • Speakers
      • Speaker
        • Category
        • Dob
        • Email
        • Events
        • Homepage
        • Name
          • First
          • Middle
          • Last
        • Phone
        • Pob
        • Role
    • Status
    • Title
    • Topics

WebcastSearchResult

An integer that indicates the success or failure of your request.

Possible values are :

0 = success

Positive (= client error):
2 = Page size exceeds 100
3 = Not authorized

Negative (= server error):
-1 = Server error
-2 = Service temporarily offline

WebcastSummaries

A list of WebcastSummary objects.

WebcastSummary

Provides basic information about a Webcast.

WebcastSummary has the following properties:

Id
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.

WebcastGetResult

An integer that indicates the success or failure of your request.

Possible values are :

0 = success

Positive (= client error):
1 = Invalid Webcast Id
3 = Not authorized

Negative (= server error):
-1 = Server error
-2 = Service temporarily offline

Webcast

Provides detailed information about a webcast.

Webcast has the following properties:

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 objects.
Attachments
A list of Attachment objects. Attachments on the Webcast level contain links to binaries such as media files and slides.
Id
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 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 objects.
Speakers
A list of Speaker objects.
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.
Topics
A list of Topic objects.

Annotation

An annotation to the Webcast.

Annotation has the following properties:

Events
A list of Event.
Text
A string. The content of the Annotation.

Event

Describes the date and time on which a parent object was active.

Event has the following properties:

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.

Attachment

Contains information about an attached binary.

Attachment has the following properties:

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.

MediaStream

Contains information about a media stream.

MediaStream has the following properties:

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.
Location
A string. Url of the media stream.
Size
A long. Size of the stream in bytes.

Slide

Contains information about a slide.

Slide has the following properties:

Attachments
A list of Attachment objects. Attachments on the Slide level contain bitmap representations of a slide in different sizes.
Events
A list of Event objects.
RawText
A string. Text exported from a slide. Use this for indexing purposes only.

Speaker

Contains information about a speaker.

Speaker has the following properties:

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 objects.
Homepage
A string. A Url to the home page of the Speaker.
Name
An object with the following properties:
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.

Topic

Contains information about a topic.

Topic has the following properties:

Attachments
A list of Attachment objects.
Events
A list of Event objects.
Title
A string. The title of the Topic.