AVPVidAuthSource Class Reference

VID and PlayAuth playback source class. More...

#include "AVPSource.h"

Inheritance diagram for AVPVidAuthSource:

Instance Methods
(instancetype)	- initWithVid:playAuth:region:
	Initialize playback source with VID and PlayAuth.
(instancetype)	- initWithVid:playAuth:region:format:playConfig:
	Initialize playback source with VID, PlayAuth, format and configuration.
(instancetype)	- initWithVid:playAuth:region:playConfig:
	Initialize playback source with VID, PlayAuth and playback configuration.

Properties
long	authTimeout
	Authentication Timeout.
NSString *	digitalWatermarkType
	Digital Watermark Type.
BOOL	enableAdaptiveCodec
NSString *	format
	Media Format.
NSString *	outputType
	outputType oss: origin address.
NSString *	playAuth
	Playback Authorization Token.
NSString *	playConfig
	Play Configuration.
NSString *	reAuthInfo
	Re-auth Information.
NSString *	region
	Region.
NSString *	resultType
	Result Type.
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 PlayAuth playback source class.

Plays media after authentication and authorization through Alibaba Cloud Video ID and playback authorization token. This is the recommended authentication method by Alibaba Cloud.

Method Documentation

initWithVid:playAuth:region:

- (instancetype) initWithVid:		(NSString *)	vid
playAuth:		(NSString *)	playAuth
region:		(NSString *)	region

Initialize playback source with VID and PlayAuth.

Creates a playback source using playback authorization token for authentication.

Parameters

vid	Alibaba Cloud Video ID
playAuth	Playback authorization token generated by server
region	Region where video is located

Returns

Initialized AVPVidAuthSource instance

initWithVid:playAuth:region:format:playConfig:

- (instancetype) initWithVid:		(NSString *)	vid
playAuth:		(NSString *)	playAuth
region:		(NSString *)	region
format:		(NSString *)	format
playConfig:		(NSString *)	playConfig

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

Parameters

vid	Alibaba Cloud Video ID
playAuth	Playback authorization token
region	Region where video is located
format	Media format
playConfig	Custom playback configuration

Returns

Initialized AVPVidAuthSource instance

initWithVid:playAuth:region:playConfig:

- (instancetype) initWithVid:		(NSString *)	vid
playAuth:		(NSString *)	playAuth
region:		(NSString *)	region
playConfig:		(NSString *)	playConfig

Initialize playback source with VID, PlayAuth and playback configuration.

Parameters

vid	Alibaba Cloud Video ID
playAuth	Playback authorization token
region	Region where video is located
playConfig	Custom playback configuration

Returns

Initialized AVPVidAuthSource instance

Property Documentation

authTimeout

- (long) authTimeout

readwritenonatomicassign

Authentication Timeout.

Timeout for PlayAuth 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.

playAuth

- (NSString*) playAuth

readwritenonatomiccopy

Playback Authorization Token.

Playback authorization token generated by server for verifying playback permission.

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.

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.

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