AmcManager

Methods

# addEventListener(type, listener)

Sets the listener to receive callbacks from WMC. To see how this method is used, see Playback Complete (p. 26).

# createPlayer(mode, mediaId, appToken)

Instructs WMC to create a player for video rendering. To see how this method is used, see Playback Complete (p. 26).

# deleteAllBookmarks()

Delete all locally saved bookmark positions

# disableTextTrack(track)

Disable a text track.

# enableCC(enabled)

Controls if Closed Caption is showing

# enableChromecast(value)

Enable/Disable Chromecast.

# enableMetrics(value)

Enables metrics.

# enableMKPApi(enable) → {boolean}

Switch between conventional and MKP rest interface

Default Value:

• false

# enableTextTrack(track)

Enable a text track.

# getAllBookmarks() → {array}

Retrieves an array of bookmark objects.

# getAmcPlayerDetails() → {string}

# getAmcVersion() → {string}

Retrieves the current WMC version.

# getAudioTracks() → {object}

Retrieves a list of available audio track IDs and the currently playing audio track.

{ audioTracks: ["audio_483_dan", "audio_482_swe"], currentAudioTrack: "audio_483_dan" }

# getAvailableVideoQualities() → {array}

Returns the list of available video qualities from player..

[{"id":"720_12121172", "label":"1280x720, 6061kbps"},{"id":"1080_16121172", "label":"1920x1080, 8061kbps"}]

# getBandwidthList() → {array}

Retrieves the list of video bandwidth contained in the DASH manifest, where each bandwidth is in bits per second (bps).

# getBeaconFailOpenConfig() → {BeaconFailOpenConfig}

# getBookmark(mediaUid) → {number}

Retrieves the bookmark position (in seconds) for a specific media unique identifier (UID).

# getBufferLength() → {object}

Get the audio and video buffer length

# getCCState() → {Boolean}

# getCurrentAudio() → {object}

Retrieves the currently playing audio track ID.

# getCurrentSubtitle() → {string}

Retrieves the current subtitle being used.

# getCurrentTime(timeMode) → {number}

Get the player current time based on the time mode.

# getDefaultInHomeStatus() → {AZUKI_HOME_STATUS_T}

Get the default inHome status

# getDvrFromRollingBuffer() → {boolean}

# getErrorEventData() → {object}

To collect various ErrorEventData parameters for Analytics usage.

# getGeofenceCoordinates() → {object}

To get GeoFences Co-ordinates

# getInHomeDetectionServiceURL() → {string}

Retrieves the third-party product (3PP) in-home detection service URL.

# getInHomeStatus() → {AZUKI_HOME_STATUS_T}

Get the inHome status

# getInHomeToken() → {string}

Retrieves the authentication in-home token that is required to access a third-party product (3PP) in-home detection service.

# getPlaybackMetrics() → {any}

Returns the playback metrics.

{"averageBitrate": 129078.5, "bitrateAudioProfiles": [130358], "bitrateAudioTimeStamp": [1630095566490], "bitrateProfiles": [258157, 520929, 831270, 1144430, 1558322, 2487897, 3113198, 4149264, 6214307], "bitrateVideoProfiles": [258157], "bitrateVideoTimeStamp": [1630095566490], "bufferFillTimes": [369, 465], "bytesTransferred": 1153558, "droppedVideoFrames": 0, "durationsWatched": 0, "playbackStalls": 2, "playbackStallsTimeStamp": [1630095586403, 1630095588904], "playbackStartOffsets": 0, "throughputTimeStamps": 0, "throughputValues": 0, "transferDuration": 30740}

# getPlaySpeed() → {number}

To get current playback rate.

# getPlayTimeUTC() → {string}

To get playback time

# getProgramInfo() → {string}

Retrieves the following information about the current program for live timeshift:

• pid:String - Program ID
• name:String - Program name
• start:String - Program start time muid:String - Program unique ID
• duration:int - Program duration in seconds

{"pid":"LIVE$CF_unenc_205_prg212","name":"LIVE$CF_une nc_205_prg212","start":"2017-08-22 17:40:00","muid":"LIVE$CF_unenc_205","duration":"3000
00"}

# getSeekableRange() → {any}

Returns the time range that is currently valid for seeking.

{"start":1624951514.26, "end":1624951774.85, "duration": 260.58}

# getStreamerSlotDuration() → {number}

# getSubtitles() → {Array}

Retrieves a list of available subtitles.

# getSubtitleState() → {Boolean}

Get the subtitle state

# getTextTracks() → {array}

Get the list of available text tracks.

# getVideoDuration() → {number}

Retrieves the video duration in seconds.

# getVideoPosition() → {number}

Retrieves the current video playback position in seconds.

# getVolume() → {number}

Get the volume.

# init(forceRegopt) → {boolean}

Initializes the WMC player and determines if WMC is to register this device.

# initialiseGeofence() → {boolean}

To initialise Geofence

# isFFEnabled() → {boolean}

To check if the fastforward PBR is enabled or not.

# isInSeekableRange(time) → {boolean}

Returns the true/false based on the current seeking time.

# isLiveEvent() → {Boolean}

# isLocationServicesEnabled() → {boolean}

To check isEnable Location services or not

# isReady() → {boolean}

Returns source ready state

# isRWEnabled() → {boolean}

To check if the rewind PBR is enabled or not

# isSourceLoaded() → {boolean}

Returns source loading state

# liveNow()

Specifies that WMC is to start the playback from the current live playback position for timeshift live.

# pause()

Instructs WMC to pause video playback.

# preload()

Deprecated:

• Retained to prevent errors from dependents still using the API. Will be removed in future releases

# removeEventListener(type, listener)

Removes a listener.

# reset()

Reset the player

# resume()

Instructs WMC to resume video playback if it was paused.

# seek(time)

Player seeks to a new playback position. When the seek() method is called the following events occur:

• The client application receives the IMC_STATE_SEEKING state change event.
• During normal playback, the client app receives the IMC_STATE_PLAYING state change event when the seek() is complete.
  or
  During pause then seek, the client app receives the IMC_STATE_PAUSED state change event when the seek() is complete.

# setAnalyticsConfig(analyticsKey, userId, videoId, videoTitle, experimentName, cdnProvideropt, customDataopt) → {boolean}

Set the analytics config parameters

wmcMgr.setAnalyticsConfig("***************");

# setAnalyticsEnabled(analyticsEnabled) → {boolean}

Controls the ability of WMC to collect and send analytics data.

# setAudio(audioTrackId) → {boolean}

Changes the currently playing audio track to the specified track.

setAudio(' Audio-UND-AAC-en')

# setBandwidth(value) → {boolean}

Sets the current quality for media type instead of letting the ABR Heuristics automatically selecting it.

# setBeaconFailOpenConfig(enableBeaconFailover, duration, initDelta, finalDelta)

# setBookmark(mediaUid, time)

Sets the bookmark position (in seconds) for a specific media unique identifier (UID).

# setBookmarkEnabled(bookmarkEnabled) → {boolean}

Controls the ability of WMC to save bookmarks locally on the device.

# setBufferLevel(value) → {boolean}

Set the player target buffer level in sec

{"video":{"forwardDuration":0,"backwardDuration":0},"audio":{"forwardDuration":0,"backwardDuration":0}}

# setCDNFailoverPercent(value) → {boolean}

Set the cdn failover percent between 0 to 100

Default Value:

• 0

# setCdnProfile(cdnProfile) → {boolean}

Set the name of CDN profile. It is optional but if needed, it must be called before calling the init() function.

# setCDNToken(token) → {boolean}

Set token for CDN url, which will be append duing manifest call

Default Value:

• null

{ "token1": "value1", "token2": "value2" }

# setCdnUrl(cdnUrl) → {boolean}

Guidelines and Restrictions

• When used, this method must be called before calling the init (p. 81) method.
• The URL must include http:// or https://.
• Avoid using the underscore (_) character in the URL as some host systems, such as Apache Lynx, do not support this character.

# setContainer(mainContainer, subtitleContainer)

Set an HTML5 HTMLMediaElement for WMC to render the media. This must be called before start() and after MRR-CC is created.

# setDefaultInHomeStatus(status)

Set default status for inHome or outHome

# setDeviceId(deviceId) → {boolean}

Set the device Id for user account. It is optional but if needed, it must be called before calling during manifest call.

# setDvrFromRollingBuffer(dvrFromRollingBuffer) → {boolean}

# setEncSeed(encSeed) → {boolean}

Sets the owner-specific encrypted seed for DRM. The seed is encrypted with Whitebox AES, from which a shared secret is generated for encrypting messages between WMC and the MRR- CC. A MediaKind proprietary software package is used to generate a pair of encrypted seeds in which one seed is specifically marked as for use on the MRR-CC (backend server) and the other seed is marked for use on WMC (client).

# setExternalSourceParams(externalSourceParams) → {boolean}

Set the external source parameters

# setGeofenceWithRadius(radius) → {object}

To set Geofences

# setInHomeDetectionServiceURL(url, endpoint) → {boolean}

Sets the third-party product (3PP) in-home detection service URL.

# setInHomeStatus(status)

Set the inHome status

# setInHomeToken(token) → {boolean}

Sets the authentication in-home token that is required to access a third-party product (3PP) in-home detection service.

# setLocationEnabled(locationEnabled)

# setLogLevel(level)

specifies the log level. The WMC supports the following log levels:
IMC_LOG_NONE: 0,
IMC_LOG_ERROR: 1, (default setting)
IMC_LOG_INFO: 2,
IMC_LOG_WARN: 3,
IMC_LOG_DEBUG: 4
See also AmcConstants for the log Level constants.

# setLowLatency(value) → {boolean}

To set LLC

# setManifestRetryCount(value) → {object}

Set the total number of retry attempts for manifest,
that will occur on a manifest load before it fails

Default Value:

• 4

# setManifestRetryInterval(value) → {object}

Set the interval of manifest retry attempts for manifest,
that will occur on a manifest load before it fails

Default Value:

• 1000 milliseconds

# setMaxBandwidth(maxBandwidth) → {boolean}

Sets the maximum bandwidth limit allowed for downloading the video content from a CDN. Specified in (kilobits per second (kbps).

# setMinBandwidth(minBandwidth) → {boolean}

Sets the minimum bandwidth limit allowed for downloading the video content from a CDN. Specified in (kilobits per second (kbps).

# setMute(value)

Set Audio mute.

# setOffset(time, timelineReference) → {bool}

Set the player startoffset time during player initialization.

// Start a VOD stream at 10.5 seconds
   {
      time: 10.5,
      timelineReference: "start" // also the default value
   }

  // Start a LIVE stream 20 seconds behind the live edge
  {
      time: -20,
      timelineReference: "end" // also the default value
  }

  // Seek to 1234567890 once playback of live event starts
  {
      time: 1234567890,
      timelineReference: "absolute"
  }

# setPlayerKey(playerKey) → {boolean}

Set the player license key.

wmcMgr.setPlayerKey("***************");

# setPlaySpeed(rate)

To set current playback rate.

PlayRate values:
 1.0 is normal speed
 0.5 is half speed (slower)
 2.0 is double speed (faster)
 -1.0 is backwards, normal speed
 -0.5 is backwards, half speed

# setPreferredAudio(preferredAudio)

Sets the following preferences for the initial audio track selection: preferredAudio, UIAudio, and audioCodec. Using a precedence algorithm, WMC attempts to pick one of the available audio tracks based on the specified preferences as follows:

• If language and UI language are specified, language takes precedence.
• If more than one track matches the specified language or UI language, the codec is used to determine which audio to use.
• If a match cannot be found, the default audio track is played.

setPreferredAudio({ preferredAudio: 'en', UIAudio: 'fr', audioCodec: 'AAC' })

# setPrimary(primary) → {boolean}

Set the primary user account. It is optional but if needed, it must be called before calling the init() function.

# setRestartThreshold(time) → {bool}

Set the player restart threshold during player initialization.

{
      time: 10
   }

# setStartBandwidth(startBandwidth) → {boolean}

Set the playback start bandwidth in kilobits per second (kbps).

# setStartOffset(startOffset)

To set Offset value

# setStartTime(time)

To set Plyaback Start Time

"2020-03-30T23:00:00Z"

# setStartupThreshold(time) → {bool}

Set the player startup threshold during player initialization.

{
      time: 10
   }

# setStartupVolumeConfig(volumeLevelopt, mutedopt)

# setSTSToken(token)

To set STS Token

# setSubtitle(lang)

Sets a new subtitle language for IMC_MODE_ADAPTIVE and IMC_MODE_LIVE modes (see createPlayer (p. 94)).

# setSubtitleState(enable)

Set the subtitle state.

# setTenantId(tenantId) → {boolean}

Set the tenant id. It is optional but if needed, it must be called before calling the init() function. This api is not required for MKP service.

# setTimeShiftMode(timeShiftMode)

To set TimeShiftMode as true/false.

# setTranscodeFormat(transcodeFormat) → {boolean}

Set the transcode format. It is optional but if needed, it must be called before calling the init() function.

# setUserProfile(profileName) → {boolean}

Set the profile name for user account. It is optional but if needed, it must be called before calling during manifest call.

# setVideoQuality(videoQualityId)

Set the player playback video quality.

# setVolume(value)

Set the volume.

# start()

Instructs WMC to start video playback.

Deprecated:

• preloadAndWait - optional parameter

# stop()

Instructs WMC to stop video playback.

# timeshiftEnabled() → {boolean}

Provides the app with the status of the requested media's timeshifting capabilities as follows:

• True - Timeshifting is enabled, which means that the following functionality is available with the media:
  -- Catchup TV - User can view previously played live video.
  -- Live Scrub - User can use the rewind, pause, resume, seek, and fast forward functions on live video.
  Note: Currently, only seek, pause, and resume are supported.
• False - Timeshifting is not enabled, which means that the user can view the live media but cannot perform any of the timeshifting functions.