enableVideoImageSource abstract method

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

Sets whether to replace the current video feeds with images when publishing video streams.

Agora recommends that you call this method after joining a channel. When publishing video streams, you can call this method to replace the current video feeds with custom images. Once you enable this function, you can select images to replace the video feeds through the ImageTrackOptions parameter. If you disable this function, the remote users see the video feeds that you publish.

• enable Whether to replace the current video feeds with custom images: true : Replace the current video feeds with custom images. false : (Default) Do not replace the current video feeds with custom images.
• options Image configurations. 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. < 0: Failure.

Implementation

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