| JSON-RPC method | Aamp Player Instance Method | Parameter | Result | Summary | Jsonrpc Request example | Jsonrpc response example |
|---|
| org.rdk.player.openSession |
| instanceId : string ,
displayId : string | sessionId : stringsuccess : boolean | Open a new player session | "jsonrpc":"2.0", "id":"123454","method":"org.rdk.player.openSession", "params":{"instanceId":"123-1232-321312-3123","displayId":"wst-mywindow"}} | {"id":"123454","jsonrpc":"2.0","result":{"sessionId":"session_1783267426","status":true}}
|
| org.rdk.player.configureSession |
| sessionId : string config : object | sessionId : stringsuccess : boolean | Apply configuration to an open session | {
"jsonrpc": "2.0",
"id": 2,
"method": "org.rdk.player.configureSession",
"params": {
"sessionId": "sess-abc-001",
"config": {
"networkTimeout": 10,
"downloadBuffer": 30,
"preferredDRM": "widevine",
"initialBitrate": 2000000
}
}
} | {
"jsonrpc": "2.0",
"id": 2,
"result": {
"sessionId": "sess-abc-001",
"success": true
}
} |
| org.dk.player.closeSession |
| sessionId : string | success : boolean | Close and release a player session | {"jsonrpc":"2.0", "id":"123454","method":"org.rdk.player.closeSession", "params":{"sessionId":"session_1783267426"}} | {"id":"123454","jsonrpc":"2.0","result":{"message":"Session closed successfully.","status":true}} |
| org.rdk.player.play | Tune | url : String autoPlay : boolean , sessionId : string | success : boolean | Instructs the AAMP to tune to the given URL. | {"jsonrpc":"2.0", "id":"123454","method":"org.rdk.player.play", "params":{"url":"http://dash.akamaized.net/dash264/TestCases/1a/qualcomm/1/MultiRate.mpd","sessionId":"session_1783267426"}} | {"id":"123454","jsonrpc":"2.0","result":{"message":"Content playback started.","status":true}} |
| org.rdk.player.stop | Stop | sessionId : string | success :boolean | Stops the current playback and releases decoder resources. The player returns to the idle state. | {"jsonrpc":"2.0", "id":"123454","method":"org.rdk.player.stop", "params":{"sessionId":"session_1783267426"}} | {"jsonrpc":"2.0","id":5,"result":{"success":true}} |
| org.rdk.player.seek | Seek | position : numberkeepPaused : boolean , sessionId : string | success : boolean | Seeks to an absolute position in the stream | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.seek","params":{"sessionId":"sess-abc-001","position":120.0,"keepPaused":false}} | {"jsonrpc":"2.0","id":5,"result":{"success":true}} |
| org.rdk.player.seekToLive | SeekToLive | keepPaused : boolean , sessionId : string | success : boolean | Seek to the live edge | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.seekToLive","params":{"keepPaused":false,"sessionId":"session_1783267426"}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
| org.rdk.player.setRate | SetRate | rate : number overshootCorrection : integer , sessionId : string | success: boolean | Set playback rate / trick-play speed | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setRate","params":{"rate":2,"overshootCorrection":0,"sessionId":"session_1783267426"}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
| org.rdk.player.setPlaybackSpeed | SetPlaybackSpeed | speed : number , sessionId : string | success: boolean | Sets the playback speed directly | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setPlaybackSpeed","params":{"speed":0.5,"sessionId":"session_1783267426"}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
| org.rdk.player.pauseAt | PauseAt | position : number , sessionId : string | success : boolean | Schedule a pause at a future position | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.pauseAt","params":{"position":300.0,"sessionId":"session_1783267426"}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
| org.rdk.player.setRateAndSeek | SetRateAndSeek | rate : integer position : number , sessionId : string | success:boolean | Atomically set rate and seek | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setRateAndSeek","params":{"rate":1,"position":60.0,"sessionId":"session_1783267426"}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
| org.rdk.player.getState | GetState | sessionId : string | state : PlayerState | Get current player state | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getState","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"state":"playing"}} |
| org.rdk.player.getPlaybackPosition | GetPlaybackPosition | sessionId : string | position : Number | Get current playback position | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getPlaybackPosition","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"position":120.5}} |
| org.rdk.player.getPlaybackDuration | GetPlaybackDuration | sessionId : string | duration : Number | Get total stream duration | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getPlaybackDuration","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"duration":3600.0}} |
| org.rdk.player.getPlaybackRate | GetPlaybackRate | sessionId : string | rate : Number | Get current playback rate | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getPlaybackRate","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"rate":1.0}} |
| org.rdk.player.isLive | IsLive | sessionId : string | isLive :Boolean | Check if stream is live | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.isLive","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"isLive":false}} |
| org.rdk.player.setVideoMute | SetVideoMute | muted : boolean , sessionId : string | success :
Boolean | Mute or unmute the video plane | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setVideoMute","params":{"sessionId":"sess-abc-001","muted":true}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
| org.rdk.player.getVideoMute | GetVideoMute | sessionId : string | muted :
Boolean | Get video mute state | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getVideoMute","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"muted":false}} |
| org.rdk.player.setAudioVolume | SetAudioVolume | volume : integer , sessionId : string | success :
Boolean | Set audio volume | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setAudioVolume","params":{"sessionId":"sess-abc-001","volume":80}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
| org.rdk.player.getAudioVolume | GetAudioVolume | sessionId : string | volume :
Integer | Get audio volume | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getAudioVolume","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"volume":80}} |
| org.rdk.player.getAudioLanguage | GetAudioLanguage | sessionId : string | language : string |
| {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getAudioLanguage","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"language":"en"}} |
org.rdk.player.getAvailableAudioTracks | GetAvailableAudioTracks | allTracks : boolean , sessionId : string | tracks :AudioTrack[] | List available audio tracks | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getAvailableAudioTracks","params":{"sessionId":"sess-abc-001","allTracks":false}} | {"jsonrpc":"2.0","id":1,"result":{"tracks":[{"index":0,"language":"en","rendition":"main","label":"English","codec":"mp4a.40.2","type":"AUDIO_STEREO","channels":2,"bitrate":128000},{"index":1,"language":"fra","rendition":"main","label":"French","codec":"mp4a.40.2","type":"AUDIO_STEREO","channels":2,"bitrate":128000}]}} |
org.rdk.player.setAudioTrack | SetAudioTrack | trackId : integer , sessionId : string | success :
Boolean | Select an audio track by index | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setAudioTrack","params":{"sessionId":"sess-abc-001","trackId":1}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
org.rdk.player.getAudioTrack | GetAudioTrack | sessionId : string | trackId:integer | Get index of active audio track | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getAudioTrack","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"trackId":0}} |
org.rdk.player.getAudioTrackInfo | GetAudioTrackInfo | sessionId : string | trackInfo:AudioTrack | Get details of active audio track | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getAudioTrackInfo","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"trackInfo":{"index":0,"language":"en","rendition":"main","label":"English","codec":"mp4a.40.2","type":"AUDIO_STEREO","channels":2,"bitrate":128000}}} |
org.rdk.player.setSubtitleMute | SetSubtitleMute | muted: boolean , sessionId : string | success: boolean | Mute or unmute subtitles | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setSubtitleMute","params":{"sessionId":"sess-abc-001","muted":true}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
org.rdk.player.getAvailableTextTracks | GetAvailableTextTracks | allTracks : boolean , sessionId : string
| tracks :
TextTrack[] | List available text/subtitle tracks | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getAvailableTextTracks","params":{"sessionId":"sess-abc-001","allTracks":false}} | {"jsonrpc":"2.0","id":1,"result":{"tracks":[{"index":0,"language":"en","rendition":"main","label":"English","type":"SUBTITLES"},{"index":1,"language":"spa","rendition":"main","label":"Spanish","type":"SUBTITLES"}]}} |
org.rdk.player.setTextTrack | SetTextTrack | trackId : integer , sessionId : string | success : boolean | Select a text track by index | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setTextTrack","params":{"sessionId":"sess-abc-001","trackId":0}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
org.rdk.player.getTextTrack | GetTextTrack | sessionId : string | trackId : integer | Get index of active text track | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getTextTrack","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"trackId":0}} |
org.rdk.player.getVideoBitrate | GetVideoBitrate | sessionId : string | bitrate : integer | Get current video bitrate | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getVideoBitrate","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"bitrate":4000000}} |
org.rdk.player.setVideoBitrate | SetVideoBitrate | bitrate : integer , sessionId : string | success : boolean | Lock the video bitrate | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setVideoBitrate","params":{"sessionId":"sess-abc-001","bitrate":2000000}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
org.rdk.player.getVideoBitrates | GetVideoBitrates | sessionId : string | bitrates :
integer[] | List all available video bitrates | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getVideoBitrates","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"bitrates":[800000,2000000,4000000,8000000]}} |
org.rdk.player.setInitialBitrate | SetInitialBitrate | bitrate : integer , sessionId : string | success : boolean | Set the startup bitrate hint | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setInitialBitrate","params":{"sessionId":"sess-abc-001","bitrate":2000000}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
org.rdk.player.getInitialBitrate | getInitialBitrat |
sessionId : string | bitrate : integer | Set the startup bitrate hint | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getInitialBitrate","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"bitrate":2000000}} |
org.rdk.player.setMinimumBitrate | SetMinimumBitrate | bitrate : integer , sessionId : string | success : boolean | Set the ABR minimum bitrate floor | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setMinimumBitrate","params":{"sessionId":"sess-abc-001","bitrate":800000}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
org.rdk.player.getMinimumBitrate | GetMinimumBitrate | sessionId : string | bitrate : integer | Get the ABR minimum bitrate floor | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getMinimumBitrate","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"bitrate":800000}} |
org.rdk.player.setMaximumBitrate | SetMaximumBitrate | sessionId : string | success : boolean | Set the ABR maximum bitrate ceiling | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setMaximumBitrate","params":{"sessionId":"sess-abc-001","bitrate":8000000}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
org.rdk.player.getMaximumBitrate | getMaximumBitrate | sessionId : string | bitrate : integer | Get the ABR maximum bitrate ceiling | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getMaximumBitrate","params":{"sessionId":"sess-abc-001"}} |
{"jsonrpc":"2.0","id":1,"result":{"bitrate":8000000}} |
rg.rdk.player.setLicenseServerURL | SetLicenseServerURL | url : string , sessionId : string | success : boolean | Set the DRM license server URL | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setLicenseServerURL","params":{"sessionId":"sess-abc-001","url":"https://license.example.com/widevine"}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
org.rdk.player.getDRM | GetDRM | sessionId : string | drm : string | Get active DRM system | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getDRM","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"drm":"widevine"}} |
org.rdk.player.setPreferredDRM | SetPreferredDRM | drmType : string , sessionId : string
| success : boolean | Set the preferred DRM system | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setPreferredDRM","params":{"sessionId":"sess-abc-001","drmType":"widevine"}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
rg.rdk.player.getAAMPConfig | GetAAMPConfig | sessionId : string | config : object | Get current AAMP configuration | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getAAMPConfig","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"config":{"networkTimeout":10,"downloadBuffer":30}}} |
org.rdk.player.setAppName | SetAppName | name : string,
sessionId : string
| success : boolean | Set the application name | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setAppName","params":{"sessionId":"sess-abc-001","name":"MyStreamingApp"}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
org.rdk.player.setPreferredLanguages | SetPreferredLanguages | languageList : string
rendition : string
codecList : string
labelList : string
sessionId : string | success : boolean |
| {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.setPreferredLanguages","params":{"sessionId":"sess-abc-001","languageList":"en,fra,spa","rendition":"main","type":"AUDIO_STEREO","codecList":"mp4a.40.2"}} | {"jsonrpc":"2.0","id":1,"result":{"success":true}} |
org.rdk.player.getPreferredLanguages | GetPreferredLanguages | sessionId : string
| languageList : sting
| Get the preferred language list | {"jsonrpc":"2.0","id":1,"method":"org.rdk.player.getPreferredLanguages","params":{"sessionId":"sess-abc-001"}} | {"jsonrpc":"2.0","id":1,"result":{"languageList":"en,fra"}} |
