Inherits: : Object

Defined in: : lib/opentok/render.rb

Overview

Represents an Experience Composer render of an OpenTok session. See / Experience Composer.

Instance Attribute Summary

• #created_at ⇒ int

  The time the Experience Composer started, expressed in milliseconds since the Unix epoch.

• #id ⇒ string

  The unique ID for the Experience Composer.

• #project_id ⇒ string

  The API key associated with the render.

• #reason ⇒ string

  The reason field is only available when the status is either “stopped” or “failed”.

• #resolution ⇒ string

  The resolution of the Experience Composer (either “640x480”, “480x640”, “1280x720”, “720x1280”, “1920x1080”, or “1080x1920”).

• #session_id ⇒ string

  The session ID of the OpenTok session associated with this render.

• #status ⇒ string

  The status of the Experience Composer.

• #streamId ⇒ string

  The ID of the composed stream being published.

• #updated_at ⇒ int

  The UNIX timestamp when the Experience Composer status was last updated.

• #url ⇒ string

  A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.

Instance Method Summary

• #info ⇒ Object

  Gets info about the OpenTok Experience Composer render.

• #stop ⇒ Object

  Stops the OpenTok Experience Composer render.

• #to_json ⇒ Object

  A JSON-encoded string representation of the Experience Composer render.

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object

Instance Attribute Details

#created_at ⇒ int

The time the Experience Composer started, expressed in milliseconds since the Unix epoch.

Returns:

• (int) —

  the current value of created_at

#id ⇒ string

The unique ID for the Experience Composer.

Returns:

• (string) —

  the current value of id

#project_id ⇒ string

The API key associated with the render.

Returns:

• (string) —

  the current value of project_id

#reason ⇒ string

The reason field is only available when the status is either “stopped” or “failed”. If the status is stopped, the reason field will contain either

"Max Duration Exceeded" or "Stop Requested." If the status is failed, the reason will contain a more specific error message.

Returns:

• (string) —

  the current value of reason

#resolution ⇒ string

The resolution of the Experience Composer (either “640x480”, “480x640”, “1280x720”, “720x1280”, “1920x1080”, or “1080x1920”).

Returns:

• (string) —

  the current value of resolution

#session_id ⇒ string

The session ID of the OpenTok session associated with this render.

Returns:

• (string) —

  the current value of session_id

#status ⇒ string

The status of the Experience Composer. Poll frequently to check status updates. This property set to one of the following:

- "starting" — The Vonage Video API platform is in the process of connecting to the remote application at the URL provided. This is the initial state.
- "started" — The Vonage Video API platform has successfully connected to the remote application server, and is publishing the web view to an OpenTok stream.
- "stopped" — The Experience Composer has stopped.
- "failed" — An error occurred and the Experience Composer could not proceed. It may occur at startup if the OpenTok server cannot connect to the remote
              application server or republish the stream. It may also occur at any point during the process due to an error in the Vonage Video API platform.

Returns:

• (string) —

  the current value of status

#streamId ⇒ string

The ID of the composed stream being published. The streamId is not available when the status is “starting” and may not be available when the status is “failed”.

Returns:

• (string) —

  the current value of streamId

#updated_at ⇒ int

The UNIX timestamp when the Experience Composer status was last updated.

Returns:

• (int) —

  the current value of updated_at

#url ⇒ string

A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.

Returns:

• (string) —

  the current value of url

Instance Method Details

#info ⇒ Object

Gets info about the OpenTok Experience Composer render.

#stop ⇒ Object

Stops the OpenTok Experience Composer render.

#to_json ⇒ Object

A JSON-encoded string representation of the Experience Composer render.