#include "AliPlayer.h"

Inheritance diagram for AliPlayer:

Instance Methods
(void)	- addExtSubtitle:
	Add external subtitle file.

(void)	- clearScreen
	Clear screen.

(void)	- clearScreenSync
	Clear screen sync.

(void)	- destroy
	Sync delete the player.

(void)	- destroyAsync
	Async delete the player.

(void)	- enableDowngrade:config:
	Modify player configuration.

(NSString *)	- getCacheFilePath:
	Query the name of the cached file with the specified URL.

(NSString *)	- getCacheFilePath:format:definition:
	Query the name of the cached file with the specified URL.

(NSString *)	- getCacheFilePath:format:definition:previewTime:
	Query the name of the cached file with the specified URL.

(AVPConfig *)	- getConfig
	Query player configuration.

(AVPTrackInfo *)	- getCurrentTrack:
	Query the track that is being played.

(AVPMediaInfo *)	- getMediaInfo
	Query media information, including track information.

(NSString *)	- getOption:
	Get player information.

(int64_t)	- getPlayedDuration
	@breif get played time, will not affected by seek

(void *)	- getPlayer

(NSString *)	- getPlayerName
	Get used player name.

(NSString *)	- getPropertyString:
	Get information by key.

(AVPMediaInfo *)	- getSubMediaInfo
	Query media sub stream information, including track information.

(void)	- getThumbnail:
	Retrieve the thumbnail image at the specified position.

(NSString *)	- getUserData
	Get user data, and each player instance bind one.

(instancetype)	- init
	Initialize the player.

(instancetype)	- init:
	Initialize the player.

(int)	- invokeComponent:
	Send command to component.

(BOOL)	- isAutoBandWidth
	Get the current status of adaptive selection of initial playback quality for multi-bitrate playback.

(BOOL)	- isEnableSubtitleRender

(void)	- pause
	Pause.

(void)	- prepare
	Prepare for playback.

(void)	- redraw
	Refresh the view in certain situations, for example, when the size of the view changes.

(void)	- reload
	Reload resources.

(void)	- reset
	Reset.

(void)	- seekToTime:seekMode:
	Seek to a specified position.

(void)	- selectExtSubtitle:enable:
	Select or disable the specified external subtitle track.

(void)	- selectTrack:
	Switch video quality according to the specified track index.

(void)	- selectTrack:accurate:
	Switch video quality according to the specified track index with accurate seeking option.

(void)	- sendCustomEvent:
	Sends a user-defined event, which will be called back via `OnReportEventListener`.

(void)	- setAuthSource:
	Play by VID and playauth.

(void)	- setAutoBandWidth:
	Enable or disable adaptive selection of initial playback quality for multi-bitrate playback.

(void)	- setBitStreamSource:
	Play by bit stream.

(BOOL)	- setCacheConfig:
	Modify cache configuration.

(void)	- setConfig:
	Modify player configuration.

(void)	- setDefaultBandWidth:
	Set the default initial playback bitrate for multi-bitrate playback.

(void)	- setDefaultResolution:
	Set the default initial playback resolution for multi-bitrate playback.

(void)	- setEnableSubtitleRender:
	is open subtitle render

(void)	- setEventReportParamsDelegate:
	Set a proxy.

(void)	- setFilterConfig:
	Set filter config.

(void)	- setFilterInvalid:invalid:
	disable/enable filter.

(void)	- setLiveStsSource:
	Play by 使用LiveSts.

(void)	- setMaxAccurateSeekDelta:
	set the maximum interval of precision seek.

(void)	- setMpsSource:
	Play by VID and MPS.

(void)	- setOption:value:
	Set specified option.

(void)	- setOption:valueInt:
	Set specified option.

(void)	- setPictureinPictureDelegate:
	set delegate for picture in picture

(void)	- setPictureInPictureEnable:
	Set picture in picture enable (The picture in picture function of the player requires systems above ios15.

(void)	- setPictureInPictureShowMode:
	set show mode for picture in picture

(void)	- setPlayerScene:
	Set player scene.

(void)	- setPlayUrlConvertCallback:
	Set a URL conversion callback.

(void)	- setPreferPlayerName:
	Sets the preferred player kernel when playing, the default is the self-developed player core, can be switched to the system player, set before calling `prepare`.

(void)	- setStartTime:seekMode:
	Set a specified position as play start.Call this API before prepare, only take effect once.

(void)	- setStreamDelayTime:time:
	set the delay time of the stream

(void)	- setStsSource:
	Play by VID and STS.

(void)	- setThumbnailUrl:
	Specify a thumbnail image URL.

(void)	- setTraceID:
	Set a trace ID for debugging.

(void)	- setUrlSource:
	Play by URL.

(void)	- setUserData:
	Set user data for the player instance, which can be used to distinguish different player instances in multi-instance scenarios.

(void)	- setVerifyStsCallback:
	During encrypted live streaming, there might be processes to change the encryption key.

(void)	- setVideoTag:size:
	Set the video tags.

(void)	- snapShot
	Create a snapshot for the current frame.

(void)	- start
	Start playing.

(void)	- stop
	Stop.

(void)	- switchStream:
	Multi definition stream switch by url.

(void)	- updateFilterConfig:options:
	upadate filter config.

(void)	- updateLiveStsInfo:accKey:token:region:
	update LiveStsInfo.

Class Methods
(NSString *)	+ getDeviceUUID
	Query device UUID.

(NSString *)	+ getSDKVersion
	Query the SDK version.

(void)	+ initPlayerComponent:function:
	Initialize player components.

(BOOL)	+ isFeatureSupport:
	judge whether support the type of feature.

(void)	+ netWorkReConnect
	reconnect all connections, call this when netWork router changed, and the player will use new router.

(void)	+ setAudioSessionDelegate:
	Set AudioSession Delegate.

(void)	+ setEnableLog:
	Enable or disable logging.

(void)	+ setLogCallbackInfo:callbackBlock:
	Set a log output callback block.

(void)	+ setLogOption:value:
	Set log option.

Properties
id< CicadaRenderDelegate > renderDelegate	__deprecated
	Set the render callback.

AVPAlphaRenderMode	alphaRenderMode
	Set alpha render mode, can be used on gift play on live stream, etc.

BOOL	autoPlay
	Enable or disable autoplay.

int64_t	bufferedPosition
	Query the buffered position.

int64_t	currentDownloadSpeed
	Query the current download speed.

int64_t	currentPosition
	Query the current playback position.

int64_t	currentUtcTime
	Query the current playback utc time.

id< AVPDelegate >	delegate
	Set a proxy.

id< AVPDrmDelegate >	drmDelegate
	set DRM request callback.

int64_t	duration
	Query the length of the video.

BOOL	enableHardwareDecoder
	Enable or disable hardware decoding.

id< AVPEventReportParamsDelegate >	eventReportParamsDelegate
	Set the event report callback.

int	height
	Query the height of the video.

int64_t	localCacheLoadedSize
	Query the current playback cached file size.

BOOL	loop
	Enable or disable loop playback.

AVPMirrorMode	mirrorMode
	Set a mirroring mode.

BOOL	muted
	Mute or unmute the player.

AVPOutputAudioChannel	outputAudioChannel
	Set the output audio channel, if input source is stereo, support select to left or right channel and if intput source is mono, this api can't take effect.

AVPStatus	playerStatus
	Query the player status.

AVPView *	playerView
	Set a player view (playerView).

float	rate
	Set the playback speed.

id< CicadaRenderingDelegate >	renderingDelegate
	Set the render callback.

AVPRotateMode	rotateMode
	Set a rotate mode.

int	rotation
	Query the rotate angle of the video, which is retrieved from the video metadata.

AVPScalingMode	scalingMode
	Set a zoom mode.

float	volume
	Query or set the volume of the player(Not system volume).

int	width
	Query the width of the video.

Method Documentation

◆ addExtSubtitle:

- (void) addExtSubtitle: (NSString *) URL

Add external subtitle file.

Supports various subtitle formats such as SRT, ASS, VTT, etc.

Parameters

URL	Subtitle file URL address, supporting local file path or network address

◆ clearScreen

- (void) clearScreen

Clear screen.

◆ clearScreenSync

- (void) clearScreenSync

Clear screen sync.

◆ destroy

- (void) destroy

Sync delete the player.

Implemented in AliListPlayer.

◆ destroyAsync

- (void) destroyAsync

Async delete the player.

When instance is not needed, skip calling stop api and call this destroyAsync api can speed up view response. Once called, don't call prepare to start new play.

Implemented in AliListPlayer.

◆ enableDowngrade:config:

- (void) enableDowngrade:		(AVPUrlSource *)	source
config:		(AVPConfig *)	config

Modify player configuration.

Parameters

source	downgrade url
config	downgrade config.

See also: AVPConfig

◆ getCacheFilePath:

- (NSString *) getCacheFilePath: (NSString *) URL

Query the name of the cached file with the specified URL.

If a custom rule is set, delegate onGetCacheNameByURL.

If the delegation failed, the default logic is used to generate the file name.

Parameters

URL	The URL of the cached file.

Returns: The name of the cached file. The file extension is not included. All files use the .alv extension.

Deprecated: From version 7.0.0, This method is deprecated.

◆ getCacheFilePath:format:definition:

- (NSString *) getCacheFilePath:	(NSString *)	vid
format:	(NSString *)	format
definition:	(NSString *)	definition

Query the name of the cached file with the specified URL.

If a custom rule is set, delegate onCacheNameByVidCallback.

If the delegation failed, the default logic is used to generate the file name.

Parameters

vid	The VID of the video.
format	The format of the video.
definition	The definition of the video.

Returns: The name of the cached file. The file extension is not included. All files use the .alv extension.

Deprecated: From version 7.0.0, This method is deprecated.

◆ getCacheFilePath:format:definition:previewTime:

- (NSString *) getCacheFilePath:	(NSString *)	vid
format:	(NSString *)	format
definition:	(NSString *)	definition
previewTime:	(int)	previewTime

Query the name of the cached file with the specified URL.

If a custom rule is set, delegate onCacheNameByVidCallback.

If the delegation failed, the default logic is used to generate the file name.

Parameters

vid	The VID of the video.
format	The format of the video.
definition	The definition of the video.
previewTime	The preview duration of the video.

Returns: The name of the cached file. The file extension is not included. All files use the .alv extension.

◆ getConfig

- (AVPConfig *) getConfig

Query player configuration.

See also: AVPConfig

◆ getCurrentTrack:

- (AVPTrackInfo *) getCurrentTrack: (AVPTrackType) type

Query the track that is being played.

Parameters

type	Track type.

See also: AVPTrackType

◆ getDeviceUUID

+ (NSString *) getDeviceUUID

Query device UUID.

◆ getMediaInfo

- (AVPMediaInfo *) getMediaInfo

Query media information, including track information.

◆ getOption:

- (NSString *) getOption: (AVPOption) key

Get player information.

Parameters

key The key

Returns: The information

◆ getPlayedDuration

- (int64_t) getPlayedDuration

@breif get played time, will not affected by seek

◆ getPlayer

- (void *) getPlayer

◆ getPlayerName

- (NSString *) getPlayerName

Get used player name.

◆ getPropertyString:

- (NSString *) getPropertyString: (AVPPropertyKey) key

Get information by key.

Parameters

key	The enum of key

Returns: corresponding information, return "" if doesn't exist.

◆ getSDKVersion

+ (NSString *) getSDKVersion

Query the SDK version.

◆ getSubMediaInfo

- (AVPMediaInfo *) getSubMediaInfo

Query media sub stream information, including track information.

◆ getThumbnail:

- (void) getThumbnail: (int64_t) positionMs

Retrieve the thumbnail image at the specified position.

Parameters

positionMs The specified position.

◆ getUserData

- (NSString *) getUserData

Get user data, and each player instance bind one.

◆ init

- (instancetype) init

Initialize the player.

Implemented in AliListPlayer, and AliVRPlayer.

◆ init:

- (instancetype) init: (NSString *) traceID

Initialize the player.

Parameters

traceID A trace ID for debugging. Set as "DisableAnalytics" to disable report analytics data to server(not recommended).

Implemented in AliListPlayer, and AliVRPlayer.

◆ initPlayerComponent:function:

+ (void) initPlayerComponent:		(NSString *)	functionName
function:		(void *)	function

Initialize player components.

These components are optional. You can remove these components by deleting the dynamic libraries and code of the components on your app.

◆ invokeComponent:

- (int) invokeComponent: (NSString *) content

Send command to component.

Parameters

content command content

Returns: < 0 on Error

Deprecated

◆ isAutoBandWidth

- (BOOL) isAutoBandWidth

Get the current status of adaptive selection of initial playback quality for multi-bitrate playback.

Returns: YES if adaptive initial quality selection is enabled, NO otherwise

◆ isEnableSubtitleRender

- (BOOL) isEnableSubtitleRender

◆ isFeatureSupport:

+ (BOOL) isFeatureSupport: (SupportFeatureType) type

judge whether support the type of feature.

Parameters

type	The type of the support feature. See SupportFeatureType.

◆ netWorkReConnect

+ (void) netWorkReConnect

reconnect all connections, call this when netWork router changed, and the player will use new router.

◆ pause

- (void) pause

Pause.

◆ prepare

- (void) prepare

Prepare for playback.

Asynchronous callback.

◆ redraw

- (void) redraw

Refresh the view in certain situations, for example, when the size of the view changes.

◆ reload

- (void) reload

Reload resources.

You can reload resources when the network connection times out.

◆ reset

- (void) reset

Reset.

◆ seekToTime:seekMode:

- (void) seekToTime:		(int64_t)	time
seekMode:		(AVPSeekMode)	seekMode

Seek to a specified position.

Parameters

time	The specified position that the player will seek to, Unit: millisecond.
seekMode	Seek mode.

See also: AVPSeekMode

◆ selectExtSubtitle:enable:

- (void) selectExtSubtitle:		(int)	trackIndex
enable:		(BOOL)	enable

Select or disable the specified external subtitle track.

Parameters

trackIndex	Subtitle track index, get available subtitle track list through media info
enable	YES to select and display the subtitle track, NO to disable subtitle display

◆ selectTrack:

- (void) selectTrack: (int) trackIndex

Switch video quality according to the specified track index.

Supports manual quality selection or adaptive bitrate mode.

Parameters

trackIndex Target quality track index. Use SELECT_AVPTRACK_TYPE_VIDEO_AUTO for adaptive bitrate adjustment

◆ selectTrack:accurate:

- (void) selectTrack:		(int)	trackIndex
accurate:		(BOOL)	accurate

Switch video quality according to the specified track index with accurate seeking option.

Parameters

trackIndex	Target quality track index. Use SELECT_AVPTRACK_TYPE_VIDEO_AUTO for adaptive bitrate adjustment
accurate	Whether to use accurate seeking mode for switching. YES for accurate seeking, NO for fast seeking

◆ sendCustomEvent:

- (void) sendCustomEvent: (NSString *) args

Sends a user-defined event, which will be called back via OnReportEventListener.

This is used to unify business events/metrics through the player's reporting callback for consistent business flow. User-defined event code is 5001, and args is the transparently transmitted parameter.

Parameters

args	The parameter passed in for the user-defined event.

◆ setAudioSessionDelegate:

+ (void) setAudioSessionDelegate: (id< CicadaAudioSessionDelegate >) delegate

Set AudioSession Delegate.

Parameters

delegate the Delegate

◆ setAuthSource:

- (void) setAuthSource: (AVPVidAuthSource *) source

Play by VID and playauth.

See https://help.aliyun.com/document_detail/57294.html

Parameters

source AVPVidAuthSource type.

See also: AVPVidAuthSource

◆ setAutoBandWidth:

- (void) setAutoBandWidth: (BOOL) enable

Enable or disable adaptive selection of initial playback quality for multi-bitrate playback.

Note: This interface only affects quality selection at startup and will not dynamically adjust quality after playback starts. The maximum resolution for adaptive selection can be limited by PlayerConfig.mMaxAllowedAbrVideoPixelNumber.

Parameters

enable YES to enable adaptive initial quality selection, NO to disable

See also: AVPConfig.maxAllowedAbrVideoPixelNumber

◆ setBitStreamSource:

- (void) setBitStreamSource: (AVPBitStreamSource *) source

Play by bit stream.

Parameters

source AVPBitStreamSource type.

See also: AVPBitStreamSource

◆ setCacheConfig:

- (BOOL) setCacheConfig: (AVPCacheConfig *) cacheConfig

Modify cache configuration.

Parameters

AVPCacheConfig Cache configuration. AVPCacheConfig.

Returns: If the cache configuration is modified, YES is returned.

Deprecated: From version 7.0.0, this interface is deprecated. Please use AliPlayerGlobalSettings::enableLocalCache:(bool)enable instead.

◆ setConfig:

- (void) setConfig: (AVPConfig *) config

Modify player configuration.

Parameters

config AVPConfig type.

See also: AVPConfig

◆ setDefaultBandWidth:

- (void) setDefaultBandWidth: (int) bandWidth

Set the default initial playback bitrate for multi-bitrate playback.

The player will select the stream closest to the specified bitrate.

Parameters

bandWidth Default playback bitrate value in bps (bits per second)

◆ setDefaultResolution:

- (void) setDefaultResolution: (int) resolutionProduct

Set the default initial playback resolution for multi-bitrate playback.

Select the closest resolution stream based on the resolution product value.

Parameters

resolutionProduct The product of width and height corresponding to the target resolution. The player will select the resolution closest to this value for initial playback. For example: passing 1920 * 1080 = 2073600, the player will select the stream closest to 1920x1080 resolution for playback

◆ setEnableLog:

+ (void) setEnableLog: (BOOL) enableLog

Enable or disable logging.

Parameters

enableLog set as true to output log

See also: Use setLogCallbackInfo.

◆ setEnableSubtitleRender:

- (void) setEnableSubtitleRender: (BOOL) enable

is open subtitle render

Parameters

enable true: open, false: close

◆ setEventReportParamsDelegate:

- (void) setEventReportParamsDelegate: (id< AVPEventReportParamsDelegate >) delegate

Set a proxy.

See AVPEventReportParamsDelegate.

See also: AVPEventReportParamsDelegate

◆ setFilterConfig:

- (void) setFilterConfig: (AVPFilterConfig *) filterConfig

Set filter config.

call this before prepare. If want update filter config, call updateFilterConfig()

Parameters

filterConfig

◆ setFilterInvalid:invalid:

- (void) setFilterInvalid:		(NSString *)	target
invalid:		(BOOL)	invalid

disable/enable filter.

Parameters

target	if empty , disable all filters.
invalid	true: enable(default); false: disable

◆ setLiveStsSource:

- (void) setLiveStsSource: (AVPLiveStsSource *) source

Play by 使用LiveSts.

Parameters

source AVPLiveStsSource type.

◆ setLogCallbackInfo:callbackBlock:

+ (void) setLogCallbackInfo:		(AVPLogLevel)	logLevel
callbackBlock:		(void(^)(AVPLogLevel logLevel, NSString *strLog))	block

Set a log output callback block.

Asynchronous.

Parameters

logLevel	The level of the log.
callbackBlock	Log output callback block, which can be nil.

◆ setLogOption:value:

+ (void) setLogOption:		(AVPLogOption)	logOption
value:		(int)	value

Set log option.

Parameters

logOption	option logOption
value	option value 0 represents off, 1 represents on

◆ setMaxAccurateSeekDelta:

- (void) setMaxAccurateSeekDelta: (int) delta

set the maximum interval of precision seek.

Parameters

delta interval in milliseconds

◆ setMpsSource:

- (void) setMpsSource: (AVPVidMpsSource *) source

Play by VID and MPS.

Parameters

source AVPVidMpsSource type.

See also: AVPVidMpsSource

Deprecated: Please use setAuthSource instead.

◆ setOption:value:

- (void) setOption:		(PlayerOption)	key
value:		(NSString *)	value

Set specified option.

◆ setOption:valueInt:

- (void) setOption:		(PlayerOption)	key
valueInt:		(int)	value

Set specified option.

Implemented in AliListPlayer.

◆ setPictureinPictureDelegate:

- (void) setPictureinPictureDelegate: (id< AliPlayerPictureInPictureDelegate >) delegate

set delegate for picture in picture

Parameters

delegate pictureInPicture delegate

◆ setPictureInPictureEnable:

- (void) setPictureInPictureEnable: (BOOL) enable

Set picture in picture enable (The picture in picture function of the player requires systems above ios15.

If other systems are available, they can be customized through the pixelbuffer returned by the player cicadarenderingdelegate)

◆ setPictureInPictureShowMode:

- (void) setPictureInPictureShowMode: (AVPPIPShowMode) pipShowMode

set show mode for picture in picture

Parameters

delegate pictureInPicture show mode

◆ setPlayerScene:

- (void) setPlayerScene: (AVPScene) scene

Set player scene.

Parameters

scene Player scene.

See also: AVPScene

◆ setPlayUrlConvertCallback:

- (void) setPlayUrlConvertCallback: (PlayURLConverCallback) callback

Set a URL conversion callback.

URL conversion is typically used in P2P broadcasting.

Parameters

callback The function pointer of the callback.

◆ setPreferPlayerName:

- (void) setPreferPlayerName: (NSString *) name

Sets the preferred player kernel when playing, the default is the self-developed player core, can be switched to the system player, set before calling prepare.

Parameters

name	Player name, such as "AppleAVPlayer", which is iOS system player, the default value is "".

◆ setStartTime:seekMode:

- (void) setStartTime:		(int64_t)	time
seekMode:		(AVPSeekMode)	seekMode

Set a specified position as play start.Call this API before prepare, only take effect once.

Parameters

time	The specified position that the player will seek to, Unit: millisecond.
seekMode	Seek mode.

See also: AVPSeekMode

◆ setStreamDelayTime:time:

- (void) setStreamDelayTime:		(int)	index
time:		(int)	time

set the delay time of the stream

Parameters

index	steam index
time	ms

Deprecated

◆ setStsSource:

- (void) setStsSource: (AVPVidStsSource *) source

Play by VID and STS.

For STS, see https://help.aliyun.com/document_detail/28756.html

Parameters

source AVPVidStsSource type.

See also: AVPVidStsSource

◆ setThumbnailUrl:

- (void) setThumbnailUrl: (NSString *) URL

Specify a thumbnail image URL.

Parameters

URL	The specified thumbnail image URL.

◆ setTraceID:

- (void) setTraceID: (NSString *) traceID

Set a trace ID for debugging.

Parameters

traceID The specified client connection trace ID.

◆ setUrlSource:

- (void) setUrlSource: (AVPUrlSource *) source

Play by URL.

Parameters

source AVPUrlSource type.

See also: AVPUrlSource

◆ setUserData:

- (void) setUserData: (NSString *) userData

Set user data for the player instance, which can be used to distinguish different player instances in multi-instance scenarios.

Can get the user data through AliPlayer::getUserData .

Parameters

userData user-defined data

◆ setVerifyStsCallback:

- (void) setVerifyStsCallback: (AVPStsStatus(^)(AVPStsInfo info)) callback

During encrypted live streaming, there might be processes to change the encryption key.

When changing keys, the latest key will be requested via STS. Developers need to monitor whether the STS is valid. If it's invalid, it will affect the playback of the encrypted live stream. Once new STS got, need to call updateLiveStsInfo to update.

Parameters

callback

◆ setVideoTag:size:

- (void) setVideoTag:		(int *)	tags
size:		(int)	size

Set the video tags.

Values range from [0,99].

Deprecated

◆ snapShot

- (void) snapShot

Create a snapshot for the current frame.

You can call AVPDelegate::onCaptureScreen to fetch the snapshot image.

◆ start

- (void) start

Start playing.

Implemented in AVPLiveTimeShift.

◆ stop

- (void) stop

Stop.

Implemented in AliListPlayer, and AVPLiveTimeShift.

◆ switchStream:

- (void) switchStream: (NSString *) URL

Multi definition stream switch by url.

You can get result from AVPDelegate onStreamSwitchedSuccess/onStreamSwitchedFail.

Parameters

url	new url address Note: Must be aliyun's live stream address. Must be different definition of the same stream. If switch to an unrelated address, switch may failed.

◆ updateFilterConfig:options:

- (void) updateFilterConfig:		(NSString *)	target
options:		(AVPFilterOptions *)	options

upadate filter config.

Parameters

target
options

◆ updateLiveStsInfo:accKey:token:region:

- (void) updateLiveStsInfo:	(NSString *)	accId
accKey:	(NSString *)	accKey
token:	(NSString *)	token
region:	(NSString *)	region

update LiveStsInfo.

Parameters

accId	the AccessKey ID for authentication.
accKey	the AccessKey Secret for authentication.
token	securityToken The specified token.
region	The specified regions.

Property Documentation

◆ __deprecated

- (id<CicadaRenderDelegate> renderDelegate) __deprecated

readwritenonatomicweak

Set the render callback.

Deprecated, use the renderingDelegate.

◆ alphaRenderMode

- (AVPAlphaRenderMode) alphaRenderMode

readwritenonatomicassign

Set alpha render mode, can be used on gift play on live stream, etc.

Detail usage: doc

See also: AVPAlphaRenderMode 默认值AVPAlphaRenderMode.AVP_RENDERMODE_ALPHA_NONE

◆ autoPlay

- (BOOL) autoPlay

readwritenonatomicassign

Enable or disable autoplay.

KVO is supported.

◆ bufferedPosition

- (int64_t) bufferedPosition

readnonatomicassign

Query the buffered position.

KVO is supported.

◆ currentDownloadSpeed

- (int64_t) currentDownloadSpeed

readnonatomicassign

Query the current download speed.

KVO is supported.

◆ currentPosition

- (int64_t) currentPosition

readnonatomicassign

Query the current playback position.

KVO is supported.

◆ currentUtcTime

- (int64_t) currentUtcTime

readnonatomicassign

Query the current playback utc time.

KVO is supported.

◆ delegate

- (id<AVPDelegate>) delegate

readwritenonatomicweak

Set a proxy.

See AVPDelegate.

See also: AVPDelegate

◆ drmDelegate

- (id<AVPDrmDelegate>) drmDelegate

readwritenonatomicweak

set DRM request callback.

This callback will be triggered only when play with setUrlSource, not VidAuth and VidSts play. Support Fairplay only.

◆ duration

- (int64_t) duration

readnonatomicassign

Query the length of the video.

KVO is supported.

◆ enableHardwareDecoder

- (BOOL) enableHardwareDecoder

readwritenonatomicassign

Enable or disable hardware decoding.

Default is enable. If hardware decoding fails, it will fall back to software decoding. If adaptive fallback is configured using AliPlayerGlobalSettings::setAdaptiveDecoderGetBackupURLCallback, the player can switch to play videos with different encodings, such as H265 to H264.

◆ eventReportParamsDelegate

- (id<AVPEventReportParamsDelegate>) eventReportParamsDelegate

readwritenonatomicweak

Set the event report callback.

◆ height

- (int) height

readnonatomicassign

Query the height of the video.

KVO is supported.

◆ localCacheLoadedSize

- (int64_t) localCacheLoadedSize

readnonatomicassign

Query the current playback cached file size.

KVO is supported.

◆ loop

- (BOOL) loop

readwritenonatomicassign

Enable or disable loop playback.

KVO is supported.

◆ mirrorMode

- (AVPMirrorMode) mirrorMode

readwritenonatomicassign

Set a mirroring mode.

KVO is supported.

See also: AVPMirrorMode

◆ muted

- (BOOL) muted

readwritenonatomicassign

Mute or unmute the player.

KVO is supported.

◆ outputAudioChannel

- (AVPOutputAudioChannel) outputAudioChannel

readwritenonatomicassign

Set the output audio channel, if input source is stereo, support select to left or right channel and if intput source is mono, this api can't take effect.

This api can take effect on both audio render and audio pcm data callback.

See also: AVPOutputAudioChannel

◆ playerStatus

- (AVPStatus) playerStatus

readnonatomicassign

Query the player status.

KVO is supported.

◆ playerView

- (AVPView*) playerView

readwritenonatomicstrong

Set a player view (playerView).

AVPView: Mac platform: NSOpenGLView. iOS platform: UIView.

◆ rate

- (float) rate

readwritenonatomicassign

Set the playback speed.

Valid values: 0.5 to 2.0. Value 1 indicates normal speed. KVO is supported.

◆ renderingDelegate

- (id<CicadaRenderingDelegate>) renderingDelegate

readwritenonatomicweak

Set the render callback.

◆ rotateMode

- (AVPRotateMode) rotateMode

readwritenonatomicassign

Set a rotate mode.

KVO is supported.

See also: AVPRotateMode

◆ rotation

- (int) rotation

readnonatomicassign

Query the rotate angle of the video, which is retrieved from the video metadata.

KVO is supported.

◆ scalingMode

- (AVPScalingMode) scalingMode

readwritenonatomicassign

Set a zoom mode.

KVO is supported.

See also: AVPScalingMode

◆ volume

- (float) volume

readwritenonatomicassign

Query or set the volume of the player(Not system volume).

KVO is supported. The range is 0.0~2.0，it maybe lead to noise if set volume more then 1.0, not recommended.

◆ width

- (int) width

readnonatomicassign

Query the width of the video.

KVO is supported.

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

AliPlayer.h

Instance Methods

Class Methods

Properties

Method Documentation

◆ addExtSubtitle:

◆ clearScreen

◆ clearScreenSync

◆ destroy

◆ destroyAsync

◆ enableDowngrade:config:

◆ getCacheFilePath:

◆ getCacheFilePath:format:definition:

◆ getCacheFilePath:format:definition:previewTime:

◆ getConfig

◆ getCurrentTrack:

◆ getDeviceUUID

◆ getMediaInfo

◆ getOption:

◆ getPlayedDuration

◆ getPlayer

◆ getPlayerName

◆ getPropertyString:

◆ getSDKVersion

◆ getSubMediaInfo

◆ getThumbnail:

◆ getUserData

◆ init

◆ init:

◆ initPlayerComponent:function:

◆ invokeComponent:

◆ isAutoBandWidth

◆ isEnableSubtitleRender

◆ isFeatureSupport:

◆ netWorkReConnect

◆ pause

◆ prepare

◆ redraw

◆ reload

◆ reset

◆ seekToTime:seekMode:

◆ selectExtSubtitle:enable:

◆ selectTrack:

◆ selectTrack:accurate:

◆ sendCustomEvent:

◆ setAudioSessionDelegate:

◆ setAuthSource:

◆ setAutoBandWidth:

◆ setBitStreamSource:

◆ setCacheConfig:

◆ setConfig:

◆ setDefaultBandWidth:

◆ setDefaultResolution:

◆ setEnableLog:

◆ setEnableSubtitleRender:

◆ setEventReportParamsDelegate:

◆ setFilterConfig:

◆ setFilterInvalid:invalid:

◆ setLiveStsSource:

◆ setLogCallbackInfo:callbackBlock:

◆ setLogOption:value:

◆ setMaxAccurateSeekDelta:

◆ setMpsSource:

◆ setOption:value:

◆ setOption:valueInt:

◆ setPictureinPictureDelegate:

◆ setPictureInPictureEnable:

◆ setPictureInPictureShowMode:

◆ setPlayerScene:

◆ setPlayUrlConvertCallback:

◆ setPreferPlayerName:

◆ setStartTime:seekMode:

◆ setStreamDelayTime:time:

◆ setStsSource:

◆ setThumbnailUrl:

◆ setTraceID:

◆ setUrlSource:

◆ setUserData:

◆ setVerifyStsCallback:

◆ setVideoTag:size:

◆ snapShot