Package com.vonage.client.video

Class RenderResponse

java.lang.Object
com.vonage.client.JsonableBaseObject
com.vonage.client.video.RenderResponse
All Implemented Interfaces:
Jsonable
public class RenderResponse extends JsonableBaseObject
Represents an Experience Composer response.
Since:
8.6.0

  • Constructor Details

  • Method Details

    • getId

      public UUID getId()
      Unique identifier for the Experience Composer.
      Returns:
      The render ID.

    • getSessionId

      public String getSessionId()
      Session ID of the Vonage Video session you are working with.
      Returns:
      The Vonage Video session ID.

    • getApplicationId

      public UUID getApplicationId()
      Vonage Application ID.
      Returns:
      The application UUID.

    • getCreatedAt

      public Long getCreatedAt()
      The time the Experience Composer started, expressed in milliseconds since the Unix epoch.
      Returns:
      The render start time as a Long.

    • getUpdatedAt

      public Long getUpdatedAt()
      UNIX timestamp when the Experience Composer status was last updated. When starting an Experience Composer for the first time, this will be the same as getCreatedAt().
      Returns:
      The last update time as a Long.

    • getUrl

      public URI getUrl()
      A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
      Returns:
      The URL.

    • getCallbackUrl

      public URI getCallbackUrl()
      Callback URL for Experience Composer events (if one was set).
      Returns:
      The callback URL, or null if unspecified.

    • getResolution

      public Resolution getResolution()
      Output resolution of the Experience Composer (either "640x480", "1280x720", "480x640", or "720x1280").
      Returns:
      The render resolution as an enum.

    • getStatus

      public RenderStatus getStatus()
      Status of the Experience Composer.
      Returns:
      The render status as an enum.

    • getStreamId

      public UUID getStreamId()
      ID of the composed stream being published. This is not available when the status is RenderStatus.STARTING and may not be available when the status is RenderStatus.FAILED.
      Returns:
      The stream ID, or null if unavailable.

    • getName

      public String getName()
      Name of the composed output stream which is published to the session.
      Returns:
      The render name.
      Since:
      8.12.0

    • getReason

      public String getReason()
      The reason field is only available when the status is either RenderStatus.STOPPED or RenderStatus.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:
      The reason, or null if not applicable.