TakeSnapshotWithConfig

Takes a screenshot of the video at the specified observation point.

UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
	int TakeSnapshotWithConfig(int64 uid, const FUABT_SnapshotConfig& config);

This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path.

Call timing

Call this method after joining a channel.

Restrictions

The method is asynchronous, and the SDK has not taken the snapshot when the method call returns.
When used for local video snapshots, this method takes a snapshot for the video streams specified in FChannelMediaOptions.

Related callbacks

After a successful call of this method, the SDK triggers the OnSnapshotTaken callback to report whether the snapshot is successfully taken, as well as the details for that snapshot.

Parameters

uid: The user ID. Set uid as 0 if you want to take a snapshot of the local user's video.
config: The configuration of the snaptshot. See FUABT_SnapshotConfig.

Returns

0: Success.
< 0: Failure.