SetCanvas

Sets the view window for displaying the video.

bool SetCanvas(Canvas *canvas, Error *err);
Since
v4.5.0

This method specifies a Canvas object to display the video. Once the the video stream sucessfully plays, the video image will be displayed on the specified canvas.

Call timing

Call this method after Player.

Restrictions

None.

Parameters

canvas
The Canvas object on which the video is rendered: Canvas
err
The state or error information: Error.

Returns

Whether the settings are successful:
  • true: Yes.
  • false: No. Refer to the error code in err to get the detaled information.