setDummyCaptureImagePath method

Future<void> setDummyCaptureImagePath(
  1. String filePath,
  2. ZegoPublishChannel channel
)

Set the path of the static picture would be published when the camera is closed.

Available: since 2.9.0 Description: Set the path of the static picture would be published when enableCamera(false) is called, it would start to publish static pictures, and when enableCamera(true) is called, it would end publishing static pictures. Use case: The developer wants to display a static picture when the camera is closed. For example, when the anchor exits the background, the camera would be actively closed. At this time, the audience side needs to display the image of the anchor temporarily leaving. When to call: After the engine is initialized, call this API to configure the parameters before closing the camera. Restrictions:

  1. Supported picture types are JPEG/JPG, PNG, BMP, HEIF.
  2. The function is only for SDK video capture and does not take effect for custom video capture.
  3. Not supported that the filePath is a network link. Caution:
  4. The static picture cannot be seen in the local preview.
  5. External filters, mirroring, watermarks, and snapshots are all invalid.
  6. If the picture aspect ratio is inconsistent with the set code aspect ratio, it will be cropped according to the code aspect ratio. Platform differences:
  7. Windows: Fill in the location of the picture directly, such as "D://dir//image.jpg".
  8. iOS: If it is a full path, add the prefix "file:", such as @"file:/var/image.png"; If it is a assets picture path, add the prefix "asset:", such as @"asset:watermark".
  9. Android: If it is a full path, add the prefix "file:", such as "file:/sdcard/image.png"; If it is a assets directory path, add the prefix "asset:", such as "asset:watermark.png".
  10. Flutter: If it is a absolute path, add the prefix "file:", such as "file:/sdcard/image.png"; If it is a assets resources directory path, add the prefix "flutter-asset://", such as "flutter-asset://assets/watermark.png".
  11. UniApp: Only absolute paths are supported. You need to add a "file:" prefix, such as: "file:/sdcard/image.png".
  • filePath Picture file path
  • channel Publish channel.

Implementation

Future<void> setDummyCaptureImagePath(
    String filePath, ZegoPublishChannel channel) async {
  return await ZegoExpressImpl.instance
      .setDummyCaptureImagePath(filePath, channel);
}