enableVideoImageSource abstract method

Future<void> enableVideoImageSource({
  1. required bool enable,
  2. required ImageTrackOptions options,
})

Enables or disables the placeholder image streaming feature.

When publishing a video stream, you can call this method to use a custom image to replace the current video stream for streaming. After enabling this feature, you can customize the placeholder image using the ImageTrackOptions parameter. After disabling the placeholder feature, remote users will still see the video stream you are currently publishing.

  • enable Whether to enable placeholder image streaming: true : Enable placeholder image streaming. false : (Default) Disable placeholder image streaming.
  • options Placeholder image settings. See ImageTrackOptions.

Returns When the method call succeeds, there is no return value; when fails, the AgoraRtcException exception is thrown. You need to catch the exception and handle it accordingly. See Error Codes for details and resolution suggestions. < 0: The method call fails. See Error Codes for details and resolution suggestions.

Implementation

Future<void> enableVideoImageSource(
    {required bool enable, required ImageTrackOptions options});