Package com.amazonaws.ivs.broadcast

Class MixedImageDeviceConfiguration

java.lang.Object
com.amazonaws.ivs.broadcast.MixedImageDeviceConfiguration
public class MixedImageDeviceConfiguration extends Object
Configuration for a MixedImageDevice.

  • Constructor Details

    • MixedImageDeviceConfiguration

      public MixedImageDeviceConfiguration()

  • Method Details

    • getSize

      @NonNull public BroadcastConfiguration.Vec2 getSize()
      Get the output size of this mixed image device.
      Returns:
      The size.

    • setSize

      @NonNull public MixedImageDeviceConfiguration setSize(BroadcastConfiguration.Vec2 size)
      Set the output size of this mixed image device.
      Parameters:
      size - The size.
      Returns:
      This configuration object for chaining.

    • isTransparencyEnabled

      public boolean isTransparencyEnabled()
      Check if transparency is enabled between the images from multiple sources.
      Returns:
      True if transparency is enabled.

    • setEnableTransparency

      @NonNull public MixedImageDeviceConfiguration setEnableTransparency(boolean enableTransparency)
      Setting this to true will enable transparency between the images from multiple sources at the cost of some memory usage.

      For example, if you wanted to broadcast the rear facing camera taking up the entire view port, and then overlay the front facing camera with 30% transparency so that you can still partially see the rear facing camera under the front facing camera, this property would need to be true.

      Note: Enabling this option does increase the memory usage of the pipeline. If you are not going to use multiple sources with blending, leave this as false.

      Parameters:
      enableTransparency - True to enable transparency.
      Returns:
      This configuration object for chaining.

    • getTargetFramerate

      public int getTargetFramerate()
      Get the target framerate of the output video stream.
      Returns:
      The target framerate.

    • setTargetFramerate

      @NonNull public MixedImageDeviceConfiguration setTargetFramerate(int targetFramerate) throws BroadcastException
      Sets the target framerate of the output video stream. This must be between 10 and 60. This is how frequently the sources attached to this mixed device will have their latest samples composited together according to their configurations.
      Parameters:
      targetFramerate - The target framerate for the output video stream.
      Returns:
      This configuration object for chaining.
      Throws:
      BroadcastException - If the framerate is not valid.