Package com.vonage.client.video

Class RenderRequest

java.lang.Object
com.vonage.client.JsonableBaseObject
com.vonage.client.video.RenderRequest
All Implemented Interfaces:
Jsonable
public final class RenderRequest extends JsonableBaseObject
Defines the parameters for starting an Experience Composer session.
Since:
8.6.0

  • Method Details

    • 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, or null if unspecified.

    • getMaxDuration

      public Integer getMaxDuration()
      Maximum time allowed for the Experience Composer, in seconds. After this time, it is stopped automatically, if it is still running. The maximum value is 36000 (10 hours), the minimum value is 60 (1 minute), and the default value is 7200 (2 hours). When the Experience Composer ends, its stream is unpublished and an event is posted to the callback URL, if configured in the Application Config.
      Returns:
      The maximum duration in seconds as an Integer, or null if unspecified.

    • getResolution

      public Resolution getResolution()
      Render resolution of the Experience Composer.
      Returns:
      The render resolution as an enum, or null if unspecified.

    • getProperties

      public RenderRequest.Properties getProperties()
      The initial configuration of Publisher properties for the composed output stream.
      Returns:
      The publisher properties object.

    • builder

      public static RenderRequest.Builder builder()
      Entry point for constructing an instance of this class.
      Returns:
      A new Builder instance.

    • getSessionId

      public String getSessionId()
      Unique identifier of the Vonage Video session.
      Returns:
      The session ID as a string.

    • getToken

      public String getToken()
      JSON Web Token with the appropriate roles for this request.
      Returns:
      The Base64-encoded JWT as a string.