Class MediaNotification

🚨 This feature is Android only

Notice for App Developers

Android setup:

MediaNotification requires adding permission on the application's AndroidManifest.xml file:

<manifest [...]>
 <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
 <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
 <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />
 [...]
</manifest>

Hierarchy

MediaNotification

Index

Methods

start play pause stop addPlayListener addPauseListener

Methods

start

start(mediaNotificationInput): Promise<void>
Start MediaNotification (🚨 Android only)

Configure the notification information and show the mediaNotification paused. If start is used twice, the second time will replace the first.

Example:
```
await Eitri.mediaNotification.start({
   track: "Music title",
   artist: "Some artist"
})
```
Compatibility Control
- API LEVEL 19 - Functionality added
Parameters
- mediaNotificationInput: MediaNotificationInput
Returns Promise<void>

play

play(): Promise<void>
Play MediaNotification (🚨 Android only)

Example:
```
await Eitri.mediaNotification.play()
```
Compatibility Control
- API LEVEL 19 - Functionality added
Returns Promise<void>

pause

pause(): Promise<void>
Pause MediaNotification (🚨 Android only)

Example:
```
await Eitri.mediaNotification.pause()
```
Compatibility Control
- API LEVEL 19 - Functionality added
Returns Promise<void>

stop

stop(): Promise<void>
Stop MediaNotification (🚨 Android only)

Close the mediaNotification.

Example:
```
await Eitri.mediaNotification.stop()
```
Compatibility Control
- API LEVEL 19 - Functionality added
Returns Promise<void>

addPlayListener

addPlayListener(callback): Promise<void>
Listen for media session PLAY event coming from notification controls (🚨 Android only)
Compatibility Control
- API LEVEL 19 - Functionality added
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns Promise<void>

addPauseListener

addPauseListener(callback): Promise<void>
Listen for media session PAUSE event coming from notification controls (🚨 Android only)
Compatibility Control
- API LEVEL 19 - Functionality added
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns Promise<void>

Class MediaNotification

Hierarchy

Index

Methods

Methods

start

Parameters

mediaNotificationInput: MediaNotificationInput

Returns Promise<void>

play

Returns Promise<void>

pause

Returns Promise<void>

stop

Returns Promise<void>

addPlayListener

Parameters

callback: (() => void)

Returns void

Returns Promise<void>

addPauseListener

Parameters

callback: (() => void)

Returns void

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page