Package com.vonage.client.video

Class RenderRequest.Builder

java.lang.Object
com.vonage.client.video.RenderRequest.Builder
Enclosing class:
RenderRequest
public static class RenderRequest.Builder extends Object
Builder for defining the parameters of RenderRequest.

  • Constructor Details

  • Method Details

    • name

      public RenderRequest.Builder name(String name)
      (REQUIRED) Name of the composed output stream which is published to the session.
      Parameters:
      name - The stream name.
      Returns:
      This builder.

    • url

      public RenderRequest.Builder url(String url)
      (REQUIRED) URL of the customer service where the callbacks will be received. This must be between 15 and 2048 characters in length.
      Parameters:
      url - The URL as a string.
      Returns:
      This builder.

    • maxDuration

      public RenderRequest.Builder maxDuration(int maxDuration)
      (OPTIONAL) 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.
      Parameters:
      maxDuration - The maximum duration in seconds as an int.
      Returns:
      This builder.

    • resolution

      public RenderRequest.Builder resolution(Resolution resolution)
      (OPTIONAL) Resolution of the display area for the composition. 1280x720 is the default.
      Parameters:
      resolution - The resolution as an enum.
      Returns:
      This builder.

    • build

      public RenderRequest build()
      Builds the RenderRequest with this builder's properties.
      Returns:
      A new RenderRequest instance.