Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

JSON-RPC methodAamp Player Instance MethodParameterResultSummary
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 : number
overshootCorrection : 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 : integer
position : 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