java.lang.Object

com.opentok.Render


public class Render extends Object

Represents an Experience Composer element response.

Method Summary

All MethodsInstance MethodsConcrete Methods

Modifier and Type

Method

Description

long

getCreatedAt()

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

String

getId()

The Render ID.

String

getProjectId()

The Project ID.

String

getReason()

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

String

getResolution()

The resolution of the Experience Composer (either "640x480", "1280x720", "480x640", or "720x1280").

String

getSessionId()

The Session ID.

RenderStatus

getStatus()

The status of the Experience Composer.

String

getStreamId()

The ID of the composed stream being published.

long

getUpdatedAt()

This timestamp matches the createdAt timestamp when calling OpenTok.getRender(String).

String

getUrl()

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getId

public String getId()

The Render ID.

getSessionId

public String getSessionId()

The Session ID.

getProjectId

public String getProjectId()

The Project ID.

getCreatedAt

public long getCreatedAt()

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

getUpdatedAt

public long getUpdatedAt()

This timestamp matches the createdAt timestamp when calling OpenTok.getRender(String).

getUrl

public String getUrl()

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

getResolution

public String getResolution()

The resolution of the Experience Composer (either "640x480", "1280x720", "480x640", or "720x1280").

getStatus

public RenderStatus getStatus()

The status of the Experience Composer.

getStreamId

public String getStreamId()

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

getReason

public String getReason()

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.