Center Stage

enableCameraCenterStage

Enables or disables Center Stage.

virtual int enableCameraCenterStage(bool enabled) = 0;

By default, Center Stage is disabled. You need to call this method to enable it. To disable the feature, call this method again and set enabled to false.

Note: This method is only applicable to iOS and macOS platforms. Due to the high performance requirements of this feature, it is recommended to use it on the following or higher-end devices:
  • iPad:
    • 12.9-inch iPad Pro (5th generation)
    • 11-inch iPad Pro (3rd generation)
    • iPad (9th generation)
    • iPad mini (6th generation)
    • iPad Air (5th generation)
  • 2020 M1 chip 13-inch MacBook Pro + iPhone 11 (using iPhone as an external camera for MacBook)
Agora recommends calling isCameraCenterStageSupported before enabling this feature to check whether the current device supports Center Stage.

Scenario

Center Stage is applicable to scenarios such as online meetings, performances, and online education. The host can use this feature to ensure they always remain centered in the frame, regardless of movement, for better presentation.

Timing

You must call this method after the camera is successfully enabled, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LOCAL_VIDEO_STREAM_STATE_CAPTURING (1).

Parameters

enabled
Whether to enable Center Stage:
  • true: Enable Center Stage.
  • false: Disable Center Stage.

Return Values

  • 0: Success.
  • < 0: Failure.

isCameraCenterStageSupported

Checks whether the current camera supports Center Stage.

virtual bool isCameraCenterStageSupported() = 0;

It is recommended to call this method before calling enableCameraCenterStage to enable Center Stage, to confirm whether the current device supports this feature. You must call this method after the camera is successfully enabled, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LOCAL_VIDEO_STREAM_STATE_CAPTURING (1).

Note: This method is only applicable to iOS and macOS platforms.

Timing

You must call this method after the camera is successfully enabled, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LOCAL_VIDEO_STREAM_STATE_CAPTURING (1).

Return Values

  • true: The current camera supports Center Stage.
  • false: The current camera does not support Center Stage.