takeRemoteSnapshot abstract method

CancelableOperation<RemoteSnapshot> takeRemoteSnapshot(
  1. RemoteStreamKey streamKey,
  2. String filePath
)

Takes a snapshot of the remote video.

streamKey: Information about the remote stream.

filePath: Save path for the snapshot.

If the API takes effect, you will receive a RemoteSnapshot object, otherwise you will receive the following error codes:

  • -1: Failure. Fails to generate the image.
  • -2: Failure. The stream is invalid.
  • -3: Failure. snapshot timeout, default 1s.
  • -100: API call exception.
  • -101: No taskId returned.
  • -102: File write failed.
  • -103: Wrong image format.

Implementation

CancelableOperation<RemoteSnapshot> takeRemoteSnapshot(
  RemoteStreamKey streamKey,
  String filePath,
);