MediaThumbnails
https://rtc-api.zego.im/
This interface is used to initiate screenshot processing tasks for on-demand audio and video media (such as CDN recorded files), including "time point screenshot" and "time interval screenshot".
- Time point screenshot: After the file starts playing, screenshots will be taken at the set time points.
- Time interval screenshot: After the file starts playing, screenshots will be taken repeatedly according to the set time interval until the file playback ends.
Call frequency limitAll rooms under the same AppID are limited to 20 times/second
Request
Query Parameters
- Tencent: Tencent Cloud.
- Huawei: Huawei Cloud.
- Tencent Cloud: FileID.
- Huawei Cloud: ObsObject.
- FileID and ObsObject parameters of the recording file generation callback.
- file_id parameter of the media file merge completion callback.
- FileId parameter of the search media interface.
- Time point screenshot: SnapshotByTimeOffset.
- Time interval screenshot: SampleSnapshot.
Possible values: [MediaThumbnails]
Interface prototype parameters
https://rtc-api.zego.im?Action=MediaThumbnails
💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.
💡Common parameter. A 16-character hexadecimal random string (hex-encoded 8-byte random number). For the generation algorithm, refer to the signature example.
💡Common parameter. Current Unix timestamp in seconds. For the generation algorithm, refer to the signature example. A maximum deviation of 10 minutes is allowed.
💡Common parameter. Signature used to verify the legitimacy of the request. Please refer to the signature mechanism to generate it.
Possible values: [2.0]
Default value: 2.0
💡Public parameter. Signature version number.
Possible values: [Tencent, Huawei]
Corresponding CDN vendor:
Unique file identifier. The unique identifiers for recording files are different for each CDN vendor:
Note
ZEGOCLOUD will not verify whether the "FileId file passed in actually exists", please pay attention to fill in the correct FileId; if an incorrect FileId is passed in, the Code in the response parameter will be 1000.
Possible values: [SnapshotByTimeOffset, SampleSnapshot]
Screenshot method.
Screenshot template ID, please contact ZEGOCLOUD Technical Support to obtain.
Only valid and required when Vendor is set to Tencent, invalid when set to Huawei.
Time points for screenshots, in seconds.
Required when Type is set to SnapshotByTimeOffset.
Time interval for continuous screenshots, in seconds.
Only valid and required when Vendor is set to Huawei, invalid when set to Tencent.
Responses
- 200
- application/json