TakeSnapshotWithConfigEx

Gets a video screenshot of the specified observation point using the connection ID.

UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
	int TakeSnapshotWithConfigEx(const FUABT_RtcConnection& connection, 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 JoinChannelEx.

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.
If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.

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

connection: The connection information. See FUABT_RtcConnection.
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.