TXPlayerAuthParams
Last updated: 2025-05-30 14:58:08
Introducing the TXPlayerAuthParams API
on-demand player playback media parameters, the Tencent Cloud fileId and playback address can be configured through TXPlayInfoParams.
API Overview
API | Description |
Application appId. | |
Video file ID. | |
Encrypted link timeout timestamp. | |
Preview duration. | |
Unique identification of request. | |
Hotlink protection signature. | |
Whether to use HTTPS request. | |
Video file URL. | |
Media asset type. | |
MP4 encryption level. | |
HTTP Header. | |
Preloaded audio track name. |
API Detail
appId
application ID. If the URL is not set, this field is required.
@property(nonatomic, assign) int appId;
fileId
video file ID. If the URL is not set, this field is required.
@property(nonatomic, copy) NSString *fileId;
timeout
encrypted link timeout timestamp. Optional, will be converted to a lowercase hexadecimal string, and the CDN server will judge whether the link is valid based on this timestamp.
@property(nonatomic, copy) NSString *fileId;
exper
Preview duration (in seconds), optional.
@property(nonatomic, assign) int exper;
us
Unique identification of request, increase link uniqueness.
@property(nonatomic, copy) NSString *us;
sign
Hotlink protection. If hotlink protection is not used, leave this parameter blank. The hotlink protection parameters (t, us, exper) used by the player API are consistent with the CDN, with the only difference being the calculation method of the sign.
Common hotlink protection signature: sign = md5(KEY + appId + fileId + t + us).
Preview edition hotlink protection signature: sign = md5(KEY + appId + fileId + t + exper + us).
@property(nonatomic, copy) NSString *sign;
https
Whether to use HTTPS request, defaults to NO.
@property(nonatomic, assign) BOOL https;
url
video URL.
@property(nonatomic, copy) NSString *url;
mediaType
Media type. Defaults to MEDIA_TYPE_AUTO.
@property(nonatomic, assign) TX_Enum_MediaType mediaType;
Parameter Description
Parameter Name | Type | Description |
mediaType | Set media asset type. Defaults to auto type. |
encryptedMp4Level
Set the encryption level for MP4 playback.
@property(nonatomic, assign) TX_Enum_MP4EncryptionLevel encryptedMp4Level;
Parameter Description
Parameter Name | Type | Description |
encryptedMp4Level | Set the encryption level for MP4 playback and storage, supported starting from Player Premium version 12.2. |
headers
Customize the Http headers carried during online playback by the player.
@property(nonatomic, strong) NSDictionary *headers;
preferAudioTrack
Set the preferred audio track for playback startup. In pre-download scenarios, configure the preferred download audio track.
Notes:
Note: Player Premium version 12.3 or later is supported.
@property(nonatomic, copy) NSString *preferAudioTrack;
Parameter Description
Parameter Name | Type | Description |
preferAudioTrack | NSString | audio track name. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback