You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »


Every API  maps one on one to a public method on the PlayerInstanceAAMP class declared in main_aamp.h in Aamp source code.


JSON-RPC methodAamp Player Instance MethodParameterResultSummary
org.rdk.player.openSession

sessionId: string
appName : string
traceUUID : string
sessionId : string
success : boolean
Open a new player session
org.rdk.player.configureSession

sessionId : string
config : object
sessionId : string
success : boolean
Apply configuration to an open session
org.dk.player.closeSession

sessionId : string
success : boolean
sessionId: String
success : boolean
Close and release a player session
org.rdk.player.tune
Tune
url : StringautoPlay : booleancontentType : StringtraceUUID : String
success : boolean
Instructs the AAMP  to tune to the given URL.
org.rdk.player.stop
Stop
None
success :boolean
Stops the current playback and releases decoder resources. The player returns to the idle state.
org.rdk.player.seek
Seek
position : numberkeepPaused : boolean
success : boolean
Seeks to an absolute position in the stream
org.rdk.player.seekToLive
SeekToLive
keepPaused : boolean
success : boolean
Seek to the live edge
org.rdk.player.setRate
SetRate
rate : numberovershootCorrection : integer
success: boolean
Set playback rate / trick-play speed
org.rdk.player.setPlaybackSpeed
SetPlaybackSpeed
speed : number
success: boolean
Sets the playback speed directly 
org.rdk.player.pauseAt
PauseAt
position : number
success : boolean
Schedule a pause at a future position
org.rdk.player.setRateAndSeek
SetRateAndSeek
rate : integerposition : number
success:boolean
Atomically set rate and seek
org.rdk.player.getState
GetState
None
state : 
PlayerState
Get current player state
org.rdk.player.getPlaybackPosition
GetPlaybackPosition
None
position : 
Number
Get current playback position
org.rdk.player.getPlaybackDuration
GetPlaybackDuration
None
duration : 
Number
Get total stream duration
org.rdk.player.getPlaybackRate
GetPlaybackRate
None
rate  : 
Number
Get current playback rate
org.rdk.player.isLive
IsLive
None
isLive :
Boolean
Check if stream is live
org.rdk.player.setVideoMute
SetVideoMute
muted : boolean

success : 
Boolean
Mute or unmute the video plane
org.rdk.player.getVideoMute
GetVideoMute
None
muted : 
Boolean
Get video mute state
org.rdk.player.setAudioVolume
SetAudioVolume
volume : integer
success : 
Boolean
Set audio volume
org.rdk.player.getAudioVolume
GetAudioVolume
None
volume : 
Integer
Get audio volume
org.rdk.player.getAudioLanguage
GetAudioLanguage





org.rdk.player.getAvailableAudioTracks
GetAvailableAudioTracks
allTracks boolean
tracks :
AudioTrack[]
List available audio tracks
org.rdk.player.setAudioTrack

SetAudioTrack
trackId : integer


success : 
Boolean

Select an audio track by index

org.rdk.player.getAudioTrack
GetAudioTrack

None

trackId:
integer

Get index of active audio track

org.rdk.player.getAudioTrackInfo
GetAudioTrackInfo

None

trackInfo:
AudioTrack


org.rdk.player.setSubtitleMute
SetSubtitleMute

muted: boolean

success: boolean

Mute or unmute subtitles





 


 

 

 


  • No labels

DISCLAIMER: Please note that the use of the RDK Wiki is subject to its Privacy Policy & Terms of Use. In addition, this Wiki may be accessed by all RDK licensees and their contractors.