MediaControlServer

The entry point for KMC server side APIs. Provides the ability to register handlers and update media session states

Implements

• IMediaControlServerAsync

Constructors

new MediaControlServer()

new MediaControlServer(): MediaControlServer

Returns

MediaControlServer

Methods

setHandlerForComponent()

setHandlerForComponent(handler, componentInstance): void

Assigns a handler to process requests for media control actions for a given component.

Parameters

handler

IMediaControlHandlerAsync

componentInstance

IComponentInstance

Returns

void

Remarks

Assigning a handler is essential for processing media control requests and implementing custom media control logic.

There is only one active handler at a time. The active handler is the one set by the most recent invocation of setHandler.

Implementation of

IMediaControlServerAsync.setHandlerForComponent

---

updateMediaSessionStates()

updateMediaSessionStates(states): void

Updates the state of the media sessions.

Parameters

states

MediaSessionState[]

Returns

void

Remarks

Updating the session states is crucial for reflecting changes in media playback status, available media streams, and other related information.

State changes can also be an action taken by a media control server application upon acting on an media control action received through the installed IMediaControlHandlerAsync instance.

Implementation of

IMediaControlServerAsync.updateMediaSessionStates

---

getMajorVersion()

static getMajorVersion(): number

Get the major version number of the TM interface

Returns

number

---

getMinorVersion()

static getMinorVersion(): number

Get the minor version number of the TM interface

Returns

number

---

getPatchVersion()

static getPatchVersion(): number

Get the patch version number of the TM interface

Returns

number

---

Last updated: Sep 30, 2025