AVPVidStsSource Class Reference

VID and STS playback source class. More...

#include "AVPSource.h"

Inheritance diagram for AVPVidStsSource:

Instance Methods
(instancetype)	- initWithVid:accessKeyId:accessKeySecret:securityToken:region:
	Initialize playback source with VID and STS information.
(instancetype)	- initWithVid:accessKeyId:accessKeySecret:securityToken:region:format:playConfig:
	Initialize playback source with VID, STS, format and configuration.
(instancetype)	- initWithVid:accessKeyId:accessKeySecret:securityToken:region:playConfig:
	Initialize playback source with VID, STS and playback configuration.

Properties
NSString *	accessKeyId
	AccessKey ID.
NSString *	accessKeySecret
	AccessKey Secret.
long	authTimeout
	Authentication Timeout.
NSString *	digitalWatermarkType
	Digital Watermark Type.
BOOL	enableAdaptiveCodec
NSString *	format
	Media Format.
NSString *	outputType
	outputType oss: origin address.
NSString *	playConfig
	Play Configuration.
NSString *	reAuthInfo
	Re-auth Information.
NSString *	region
	Region.
NSString *	resultType
	Result Type.
NSString *	securityToken
	Security Token.
NSString *	streamType
	Stream Type.
NSString *	trace
NSString *	vid
	Video ID.
Properties inherited from AVPSource
NSString *	coverURL
	The URL of the album cover.
NSString *	definitions
	List of resolution types supported by VOD server.
BOOL	forceQuality
	Whether to force the player to use the specified resolution.
NSString *	quality
	The preferred definition for playback.
NSString *	title
	The title of the video.

Detailed Description

VID and STS playback source class.

Plays media after authentication and authorization through Alibaba Cloud Video ID and temporary security token. Suitable for scenarios requiring access control.

Method Documentation

initWithVid:accessKeyId:accessKeySecret:securityToken:region:

- (instancetype) initWithVid:		(NSString *)	vid
accessKeyId:		(NSString *)	accessKeyId
accessKeySecret:		(NSString *)	accessKeySecret
securityToken:		(NSString *)	securityToken
region:		(NSString *)	region

Initialize playback source with VID and STS information.

Creates a playback source using temporary security token for authentication.

Play by VID and STS. Temporary AccessKey ID, AccessKey Secret, and token: Activate RAM, and use the API or SDK provided by STS to retrieve the AccessKey ID, AccessKey Secret, and token. Details about parameters in playback and download requests: https://help.aliyun.com/document_detail/28788.html?spm=5176.doc28787.6.706.2G5SLS

Parameters

vid	Alibaba Cloud Video ID uniquely identifying a video
accessKeyId	STS temporary AccessKey ID
accessKeySecret	STS temporary AccessKey Secret
securityToken	STS security token
region	Region where video is located, such as "cn-shanghai"

Returns

Initialized AVPVidStsSource instance

initWithVid:accessKeyId:accessKeySecret:securityToken:region:format:playConfig:

- (instancetype) initWithVid:		(NSString *)	vid
accessKeyId:		(NSString *)	accessKeyId
accessKeySecret:		(NSString *)	accessKeySecret
securityToken:		(NSString *)	securityToken
region:		(NSString *)	region
format:		(NSString *)	format
playConfig:		(NSString *)	playConfig

Initialize playback source with VID, STS, format and configuration.

Creates a playback source specifying media format and playback configuration.

Parameters

vid	Alibaba Cloud Video ID
accessKeyId	STS temporary AccessKey ID
accessKeySecret	STS temporary AccessKey Secret
securityToken	STS security token
region	Region where video is located
format	Media format with multiple formats separated by commas, e.g., "mp4,mp3,flv,m3u8"
playConfig	Custom playback configuration

Returns

Initialized AVPVidStsSource instance

initWithVid:accessKeyId:accessKeySecret:securityToken:region:playConfig:

- (instancetype) initWithVid:		(NSString *)	vid
accessKeyId:		(NSString *)	accessKeyId
accessKeySecret:		(NSString *)	accessKeySecret
securityToken:		(NSString *)	securityToken
region:		(NSString *)	region
playConfig:		(NSString *)	playConfig

Initialize playback source with VID, STS and playback configuration.

Creates a playback source using temporary security token and custom playback configuration.

Parameters

vid	Alibaba Cloud Video ID
accessKeyId	STS temporary AccessKey ID
accessKeySecret	STS temporary AccessKey Secret
securityToken	STS security token
region	Region where video is located
playConfig	Custom playback configuration as JSON string

Returns

Initialized AVPVidStsSource instance

Property Documentation

accessKeyId

- (NSString*) accessKeyId

readwritenonatomiccopy

AccessKey ID.

ID of STS temporary AccessKey used for authentication.

accessKeySecret

- (NSString*) accessKeySecret

readwritenonatomiccopy

AccessKey Secret.

STS temporary AccessKey Secret used for signature verification.

authTimeout

- (long) authTimeout

readwritenonatomicassign

Authentication Timeout.

Timeout for STS authentication in milliseconds.

digitalWatermarkType

- (NSString*) digitalWatermarkType

readwritenonatomiccopy

Digital Watermark Type.

TraceMark: Trace Watermark. CopyrightMark: Copyright Watermark

enableAdaptiveCodec

- (BOOL) enableAdaptiveCodec

readwritenonatomicassign

format

- (NSString*) format

readwritenonatomiccopy

Media Format.

Specifies media format type. Multiple formats separated by commas, e.g., "mp4,mp3,flv,m3u8".

outputType

- (NSString*) outputType

readwritenonatomiccopy

outputType oss: origin address.

cdn (default): acceleration address.

playConfig

- (NSString*) playConfig

readwritenonatomiccopy

Play Configuration.

Custom playback configuration in JSON format. Constructing reference:

reAuthInfo

- (NSString*) reAuthInfo

readwritenonatomiccopy

Re-auth Information.

CDN re-auth parameter, in JSON string. When URL-based A-type authentication is enabled, you can set the uid and rand parameters for the re-auth URL, please refer to the A-type authentication method description

region

- (NSString*) region

readwritenonatomiccopy

Region.

Alibaba Cloud region identifier where video is located, such as "cn-shanghai".

resultType

- (NSString*) resultType

readwritenonatomiccopy

Result Type.

Single (default): Each clarity and format returns only one latest transcoded stream. Multiple: Each clarity and format returns all transcoded streams.

Specifies the result type for retrieving media information.

securityToken

- (NSString*) securityToken

readwritenonatomiccopy

Security Token.

STS security token as part of temporary credentials.

streamType

- (NSString*) streamType

readwritenonatomiccopy

Stream Type.

video/audio

trace

- (NSString*) trace

readwritenonatomiccopy

vid

- (NSString*) vid

readwritenonatomiccopy

Video ID.

Alibaba Cloud Video ID uniquely identifying a video resource.

---

The documentation for this class was generated from the following file:

• AVPSource.h