![]() |
AliyunPlayer
v5.4.6.0
Aliyun Player API Reference Manual for iOS Platforms
|
Instance Methods | |
| (void) | - addUrlSource:uid: |
| Add a resource to the playlist. More... | |
| (void) | - addVidSource:uid: |
| Add a resource to the playlist. More... | |
| (void) | - clear |
| Clear the playlist. More... | |
| (NSString *) | - currentUid |
| Query the UID of the resource that is being played. More... | |
| (void) | - destroy |
| Delete the player. More... | |
| (instancetype) | - init |
| Initialize the playlist. More... | |
| (instancetype) | - init: |
| Initialize the player. More... | |
| (BOOL) | - moveTo: |
| Seek to the specified position and prepare for playback. More... | |
| (BOOL) | - moveTo:accId:accKey:token:region: |
| Seek to the specified resource and prepare for playback. More... | |
| (BOOL) | - moveToNext |
| Seek to the next resource and prepare for playback. More... | |
| (BOOL) | - moveToNext:accKey:token:region: |
| Seek to the next resource and prepare for playback. More... | |
| (BOOL) | - moveToPre |
| Seek to the previous resource and prepare for playback. More... | |
| (BOOL) | - moveToPre:accKey:token:region: |
| Seek to the previous resource and prepare for playback. More... | |
| (void) | - removeSource: |
| Remove a resource from the playlist. More... | |
| (void) | - stop |
| Stop. More... | |
Instance Methods inherited from AliPlayer | |
| (void) | - addExtSubtitle: |
| Add external subtitles. More... | |
| (void) | - clearScreen |
| Clear screen. More... | |
| (void) | - DEPRECATED_ATTRIBUTE |
| Reset. More... | |
| ("will not take effect") | - DEPRECATED_MSG_ATTRIBUTE |
| Refresh the view in certain situations, for example, when the size of the view changes. More... | |
| (NSString *) | - getCacheFilePath: |
| Query the name of the cached file with the specified URL. More... | |
| (NSString *) | - getCacheFilePath:format:definition: |
| Query the name of the cached file with the specified URL. More... | |
| (NSString *) | - getCacheFilePath:format:definition:previewTime: |
| Query the name of the cached file with the specified URL. More... | |
| (AVPConfig *) | - getConfig |
| Query player configuration. More... | |
| (AVPTrackInfo *) | - getCurrentTrack: |
| Query the track that is being played. More... | |
| (AVPMediaInfo *) | - getMediaInfo |
| Query media information, including track information. More... | |
| (NSString *) | - getOption: |
| Get player information. More... | |
| (void *) | - getPlayer |
| (NSString *) | - getPlayerName |
| Get used player name. More... | |
| (NSString *) | - getPropertyString: |
| Get information by key. More... | |
| (void) | - getThumbnail: |
| Retrieve the thumbnail image at the specified position. More... | |
| (int) | - invokeComponent: |
| Send command to component. More... | |
| (void) | - pause |
| Pause. More... | |
| (void) | - prepare |
| Prepare for playback. More... | |
| (void) | - reload |
| Reload resources. More... | |
| (void) | - seekToTime:seekMode: |
| Seek to a specified position. More... | |
| (void) | - selectExtSubtitle:enable: |
| Select external subtitles. More... | |
| (void) | - selectTrack: |
| Switch definition according to the specified track index. More... | |
| (void) | - selectTrack:accurate: |
| Switch definition according to the specified track index. More... | |
| (void) | - sendCustomEvent: |
| Send custom event, will callback through AVPEventReportParamsDelegate. More... | |
| (void) | - setAuthSource: |
| Play by VID and playauth. More... | |
| (void) | - setBitStreamSource: |
| Play by bit stream. More... | |
| (BOOL) | - setCacheConfig: |
| Modify cache configuration. More... | |
| (void) | - setConfig: |
| Modify player configuration. More... | |
| (void) | - setDefaultBandWidth: |
| Set the default playback bitrate for multi-bit rate. More... | |
| (void) | - setEventReportParamsDelegate: |
| Set a proxy. More... | |
| (void) | - setFilterConfig: |
| Set filter config. More... | |
| (void) | - setFilterInvalid:invalid: |
| disable/enable filter. More... | |
| (void) | - setLiveStsSource: |
| Play by 使用LiveSts. More... | |
| (void) | - setMaxAccurateSeekDelta: |
| set the maximum interval of precision seek. More... | |
| (void) | - setMpsSource: |
| Play by VID and MPS. More... | |
| (void) | - setPlayUrlConvertCallback: |
| Set a URL conversion callback. More... | |
| (void) | - setPreferPlayerName: |
| Set preper player name. More... | |
| (void) | - setStreamDelayTime:time: |
| set the delay time of the stream More... | |
| (void) | - setStsSource: |
| Play by VID and STS. More... | |
| (void) | - setThumbnailUrl: |
| Specify a thumbnail image URL. More... | |
| (void) | - setTraceID: |
| Set a trace ID for debugging. More... | |
| (void) | - setUrlSource: |
| Play by URL. More... | |
| (void) | - setVerifyStsCallback: |
| Set the AVPStsInfo expiration callback. More... | |
| (void) | - setVideoTag:size: |
| Set the video tags. More... | |
| (void) | - snapShot |
| Snapshot. More... | |
| (void) | - start |
| Start playing. More... | |
| (void) | - updateFilterConfig:options: |
| upadate filter config. More... | |
| (void) | - updateLiveStsInfo:accKey:token:region: |
| update liveSts info. More... | |
Properties | |
| int | maxPreloadMemorySizeMB |
| Set the maximum preloading cache size. More... | |
| int | preloadCount |
| Query or set the number of preloaded resources. More... | |
| NSString * | stsPreloadDefinition |
| Query or set the definition for playback by STS, such as LD or HD. More... | |
Properties inherited from AliPlayer | |
| id< CicadaRenderDelegate > renderDelegate | __deprecated |
| Set the render callback. More... | |
| BOOL | autoPlay |
| Enable or disable autoplay. More... | |
| int64_t | bufferedPosition |
| Query the buffered position. More... | |
| int64_t | currentDownloadSpeed |
| Query the current download speed. More... | |
| int64_t | currentPosition |
| Query the current playback position. More... | |
| int64_t | currentUtcTime |
| Query the current playback utc time. More... | |
| id< AVPDelegate > | delegate |
| Set a proxy. More... | |
| int64_t | duration |
| Query the length of the video. More... | |
| BOOL | enableHardwareDecoder |
| Enable or disable hardware decoding. More... | |
| id< AVPEventReportParamsDelegate > | eventReportParamsDelegate |
| Set the event report callback. More... | |
| int | height |
| Query the height of the video. More... | |
| int64_t | localCacheLoadedSize |
| Query the current playback cached file size. More... | |
| BOOL | loop |
| Enable or disable loop playback. More... | |
| AVPMirrorMode | mirrorMode |
| Set a mirroring mode. More... | |
| BOOL | muted |
| Mute or unmute the player. More... | |
| AVPView * | playerView |
| Set a player view (playerView). More... | |
| float | rate |
| Set the playback speed. More... | |
| id< CicadaRenderingDelegate > | renderingDelegate |
| Set the render callback. More... | |
| AVPRotateMode | rotateMode |
| Set a rotate mode. More... | |
| int | rotation |
| Query the rotate angle of the video, which is retrieved from the video metadata. More... | |
| AVPScalingMode | scalingMode |
| Set a zoom mode. More... | |
| float | volume |
| Query or set the volume of the player(Not system volume). More... | |
| int | width |
| Query the width of the video. More... | |
Additional Inherited Members | |
Class Methods inherited from AliPlayer | |
| (NSString *) | + getDeviceUUID |
| Query device UUID. More... | |
| (NSString *) | + getSDKVersion |
| Query the SDK version. More... | |
| (void) | + initPlayerComponent:function: |
| Initialize player components. More... | |
| (void) | + netWorkReConnect |
| reconnect all connections, call this when netWork router changed, and the player will use new router. More... | |
| (void) | + setAudioSessionDelegate: |
| Set AudioSession Delegate. More... | |
| (void) | + setEnableLog: |
| Enable or disable logging. More... | |
| (void) | + setLogCallbackInfo:callbackBlock: |
| Set a log output callback block. More... | |
| - (void) addUrlSource: | (NSString *) | url | |
| uid: | (NSString *) | uid | |
Add a resource to the playlist.
| url | Specify a resource by URL. |
| uid | The UID of the resource, which uniquely identifies a resource. |
| - (void) addVidSource: | (NSString *) | vid | |
| uid: | (NSString *) | uid | |
Add a resource to the playlist.
| vid | Specify a resource by VID. |
| uid | The UID of the resource, which uniquely identifies a resource. |
| - (void) clear |
Clear the playlist.
| - (NSString*) currentUid |
Query the UID of the resource that is being played.
| - (void) destroy |
Delete the player.
Implements AliPlayer.
| - (instancetype) init |
Initialize the playlist.
Implements AliPlayer.
| - (instancetype) init: | (NSString *) | traceID |
| - (BOOL) moveTo: | (NSString *) | uid |
Seek to the specified position and prepare for playback.
Only playback by URL is supported.
| uid | The UID of the specified resource, which uniquely identifies a resource. |
| - (BOOL) moveTo: | (NSString *) | uid | |
| accId: | (NSString *) | accId | |
| accKey: | (NSString *) | accKey | |
| token: | (NSString *) | token | |
| region: | (NSString *) | region | |
Seek to the specified resource and prepare for playback.
Only playback by STS is supported. You must update the STS information.
| uid | The UID of the specified resource, which uniquely identifies a resource. |
| accId | vid The AccessKey ID. |
| accKey | vid The AccessKey Secret. |
| token | vid The STS token. |
| region | vid The specified region. Default: cn-shanghai. |
| - (BOOL) moveToNext |
Seek to the next resource and prepare for playback.
Only playback by URL is supported.
| - (BOOL) moveToNext: | (NSString *) | accId | |
| accKey: | (NSString *) | accKey | |
| token: | (NSString *) | token | |
| region: | (NSString *) | region | |
Seek to the next resource and prepare for playback.
Only playback by STS is supported. You must update the STS information.
| accId | vid The AccessKey ID. |
| accKey | vid The AccessKey Secret. |
| token | vid The STS token. |
| region | vid The specified region. Default: cn-shanghai. |
| - (BOOL) moveToPre |
Seek to the previous resource and prepare for playback.
Only playback by URL is supported.
| - (BOOL) moveToPre: | (NSString *) | accId | |
| accKey: | (NSString *) | accKey | |
| token: | (NSString *) | token | |
| region: | (NSString *) | region | |
Seek to the previous resource and prepare for playback.
Only playback by STS is supported. You must update the STS information.
| accId | vid The AccessKey ID. |
| accKey | vid The AccessKey Secret. |
| token | vid The STS token. |
| region | vid The specified region. Default: cn-shanghai. |
| - (void) removeSource: | (NSString *) | uid |
Remove a resource from the playlist.
| uid | The UID of the resource, which uniquely identifies a resource. |
| - (void) stop |
Stop.
Implements AliPlayer.
|
readwritenonatomicassign |
Set the maximum preloading cache size.
Default: 100 MB. Minimum: 20 MB.
|
readwritenonatomicassign |
Query or set the number of preloaded resources.
The number of resources before preloading and the number of resources after preloading are returned. Default: 2.
|
readwritenonatomiccopy |
Query or set the definition for playback by STS, such as LD or HD.
Call this method before moveTo. After the resources are preloaded, you cannot change the definition.