CanvasConfig

This class provides methods relevant to video rendering by the player.

public class CanvasConfig {
  public void setVideoRenderMode(Constants.VideoRenderMode mode) throws RteException ;
  public Constants.VideoRenderMode getVideoRenderMode() throws RteException ;
  public void setVideoMirrorMode(Constants.VideoMirrorMode mode) throws RteException ;
  public Constants.VideoMirrorMode getVideoMirrorMode() throws RteException ;
}

Since: v4.5.0

Method

setRenderMode: Sets the vide render mode. See setRenderMode.
getRenderMode: Gets the current video rendering mode setting. See getRenderMode.
setMirrorMode: Sets the rendering mode of the video. See setMirrorMode.
getMirrorMode: Get the current video mirror mode setting. See getMirrorMode.

getMirrorMode

Gets the current image mode setting.

public Constants.VideoMirrorMode getVideoMirrorMode() throws RteException ;

Since: v4.5.0

Call timing

Call this method after getConfigs [3/3].

Restrictions

None.

Returns

The current image mode. See VideoMirrorMode.

Exception

If the method call fails, the SDK throws RteException and returns an error message. You need to catch the exception and handle it.

getRenderMode

Gets the current video render mode.

public Constants.VideoRenderMode getVideoRenderMode() throws RteException ;

Since: v4.5.0

Call timing

Call this method after getConfigs [3/3].

Restrictions

None.

Returns

The current video rendering mode. See VideoRenderMode.

Exception

If the method call fails, the SDK throws RteException and returns an error message. You need to catch the exception and handle it.

setMirrorMode

Sets the mirror mode of the video.

public void setVideoMirrorMode(Constants.VideoMirrorMode mode) throws RteException ;

Since: v4.5.0

Call timing

Call this method after setConfigs [3/3].

Restrictions

None.

Parameters

mode: The mirror mode. See VideoMirrorMode. The default value is AUTO, which means to be determined by the SDK. The SDK disables mirror mode by default.

Exception

If the method call fails, the SDK throws RteException and returns an error message. You need to catch the exception and handle it.

setRenderMode

Sets the vide render mode.

public void setVideoRenderMode(Constants.VideoRenderMode mode) throws RteException ;

Since: v4.5.0

Call timing

Call this method after setConfigs [3/3].

Restrictions

None.

Parameters

mode: The video rendering mode. See VideoRenderMode. The default rendering mode is HIDDEN, which means that the video size is scaled proportionally to fill the view.

Exception

If the method call fails, the SDK throws RteException and returns an error message. You need to catch the exception and handle it.