@skylabs_technology/capacitor-mixer v0.9.21

Mixer Plugin by Skylabs Technology

Android

Usage

Minimum target deployment: 28

to set this value you can add this to your ./android/variables.gradle

ext {
    minSdkVersion = 28
}

Permissions

<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="@string/custom_url_scheme" />
</intent-filter>
<intent-filter>
    <action android:name="android.intent.action.OPEN_DOCUMENT" />
    <category android:name="android.intent.category.DEFAULT" />
    <data android:scheme="io.ionic.starter" />
    <data android:mimeType="audio/*" />
</intent-filter>

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"></uses-permission>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"></uses-permission>
<uses-permission android:name="android.permission.RECORD_AUDIO"></uses-permission>
<uses-permission android:name="android.permission.READ_PHONE_STATE"></uses-permission>

API

• requestMixerPermissions()
• addListener(string, ...)
• addListener(string, ...)
• addListener(string, ...)
• playOrPause(...)
• stop(...)
• isPlaying(...)
• getCurrentVolume(...)
• getCurrentEq(...)
• initAudioFile(...)
• adjustVolume(...)
• adjustEq(...)
• setElapsedTimeEvent(...)
• getElapsedTime(...)
• getTotalTime(...)
• initMicInput(...)
• getInputChannelCount()
• initAudioSession(...)
• deinitAudioSession()
• checkAudioSessionState()
• resetPlugin()
• getAudioSessionPreferredInputPortType()
• destroyMicInput(...)
• destroyAudioFile(...)
• validateFileUri(...)
• startStream(...)
• stopStream()
• Interfaces
• Type Aliases
• Enums

requestMixerPermissions()

requestMixerPermissions() => Promise<BaseResponse<null>>

Requests permissions required by the mixer plugin

• iOS: Permissions must be added to application in the Info Target Properties

• Android: Permissions must be added to AndroidManifest.XML

See README for additional information on permissions

Returns: Promise<BaseResponse<null>>

addListener(string, ...)

addListener(eventName: string, listenerFunc: (response: AudioSessionEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Adds listener for AudioSession events

Ex:

Register Listener:

Mixer.addListener("myEventName", this.myListenerFunction.bind(this));

myListenerFunction(response: <a href="#audiosessionevent">AudioSessionEvent</a>) { 
 // handle event 
}

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener(string, ...)

addListener(eventName: string, listenerFunc: (response: MixerTimeEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Adds listener for audio track time update events

Ex:

Register Listener:

Mixer.addListener("myEventName", this.myListenerFunction.bind(this));

myListenerFunction(response: <a href="#mixertimeevent">MixerTimeEvent</a>) { 
 // handle event 
}

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener(string, ...)

addListener(eventName: string, listenerFunc: (response: VolumeMeterEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Adds listener for volume metering update events

Ex:

Register Listener:

Mixer.addListener("myEventName", this.myListenerFunction.bind(this));

myListenerFunction(response: <a href="#volumemeterevent">VolumeMeterEvent</a>) { 
 // handle event 
}

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

playOrPause(...)

playOrPause(request: BaseMixerRequest) => Promise<BaseResponse<PlaybackStateResponse>>

Toggles playback and pause on an initialized audio file

Returns: Promise<BaseResponse<PlaybackStateResponse>>

stop(...)

stop(request: BaseMixerRequest) => Promise<BaseResponse<PlaybackStateResponse>>

Stops playback on a playing audio file

Returns: Promise<BaseResponse<PlaybackStateResponse>>

isPlaying(...)

isPlaying(request: BaseMixerRequest) => Promise<BaseResponse<IsPlayingResponse>>

A boolean that returns the playback state of initialized audio file

Returns: Promise<BaseResponse<IsPlayingResponse>>

getCurrentVolume(...)

getCurrentVolume(request: ChannelPropertyRequest) => Promise<BaseResponse<VolumeResponse>>

Returns current volume of a channel as a number between 0 and 1

Returns: Promise<BaseResponse<VolumeResponse>>

getCurrentEq(...)

getCurrentEq(request: ChannelPropertyRequest) => Promise<BaseResponse<EqResponse>>

Returns an object with numeric values for gain and frequency in bass, mid, and treble ranges

Returns: Promise<BaseResponse<EqResponse>>

initAudioFile(...)

initAudioFile(request: InitChannelRequest) => Promise<BaseResponse<InitResponse>>

Returns AudioId string of initialized audio file

Returns: Promise<BaseResponse<InitResponse>>

adjustVolume(...)

adjustVolume(request: AdjustVolumeRequest) => Promise<BaseResponse<null>>

Adjusts volume for a channel

Returns: Promise<BaseResponse<null>>

adjustEq(...)

adjustEq(request: AdjustEqRequest) => Promise<BaseResponse<null>>

Adjusts gain and frequency in bass, mid, and treble ranges for a channel

Returns: Promise<BaseResponse<null>>

setElapsedTimeEvent(...)

setElapsedTimeEvent(request: SetEventRequest) => Promise<BaseResponse<null>>

Sets an elapsed time event name for a given audioId. To unset elapsedTimeEvent pass an empty string and this will stop the event from being triggered.

Only applicable for audio files

Returns: Promise<BaseResponse<null>>

getElapsedTime(...)

getElapsedTime(request: BaseMixerRequest) => Promise<BaseResponse<MixerTimeResponse>>

Returns an object representing hours, minutes, seconds, and milliseconds elapsed

Returns: Promise<BaseResponse<MixerTimeResponse>>

getTotalTime(...)

getTotalTime(request: BaseMixerRequest) => Promise<BaseResponse<MixerTimeResponse>>

Returns total time in an object of hours, minutes, seconds, and millisecond totals

Returns: Promise<BaseResponse<MixerTimeResponse>>

initMicInput(...)

initMicInput(request: InitChannelRequest) => Promise<BaseResponse<InitResponse>>

Initializes microphone channel on mixer

Returns AudioId string of initialized microphone input

Returns: Promise<BaseResponse<InitResponse>>

getInputChannelCount()

getInputChannelCount() => Promise<BaseResponse<ChannelCountResponse>>

Returns the channel count and name of the initialized audio device

Returns: Promise<BaseResponse<ChannelCountResponse>>

initAudioSession(...)

initAudioSession(request: InitAudioSessionRequest) => Promise<BaseResponse<InitAudioSessionResponse>>

Initializes audio session with selected port type,

Returns a value describing the initialized port type for the audio session (usb, built-in, etc.)

Returns: Promise<BaseResponse<InitAudioSessionResponse>>

deinitAudioSession()

deinitAudioSession() => Promise<BaseResponse<null>>

Cancels audio session and resets selected port. Use prior to changing port type

Returns: Promise<BaseResponse<null>>

checkAudioSessionState()

checkAudioSessionState() => Promise<BaseResponse<SessionStateResponse>>

Checks the current state of the AudioSession.

Returns: Promise<BaseResponse<SessionStateResponse>>

resetPlugin()

resetPlugin() => Promise<BaseResponse<null>>

Resets plugin state back to its initial state

<span style="color: 'red'">CAUTION: This will completely wipe everything you have initialized from the plugin!</span>

Returns: Promise<BaseResponse<null>>

getAudioSessionPreferredInputPortType()

getAudioSessionPreferredInputPortType() => Promise<BaseResponse<InitResponse>>

Returns a value describing the initialized port type for the audio session (usb, built-in, etc.)

Returns: Promise<BaseResponse<InitResponse>>

destroyMicInput(...)

destroyMicInput(request: BaseMixerRequest) => Promise<BaseResponse<DestroyResponse>>

De-initializes a mic input channel based on audioId

Note: Once destroyed, the channel cannot be recovered

Returns: Promise<BaseResponse<DestroyResponse>>

destroyAudioFile(...)

destroyAudioFile(request: BaseMixerRequest) => Promise<BaseResponse<DestroyResponse>>

De-initializes an audio file channel based on audioId

Note: Once destroyed, the channel cannot be recovered

Returns: Promise<BaseResponse<DestroyResponse>>

validateFileUri(...)

validateFileUri(request: FileValidationRequest) => Promise<BaseResponse<FileValidationResponse>>

Validates file path and returns true if valid, false if invalid

Returns: Promise<BaseResponse<FileValidationResponse>>

startStream(...)

startStream(request: StreamRequest) => Promise<BaseResponse<null>>

Starts a stream to a provided URL

Returns: Promise<BaseResponse<null>>

stopStream()

stopStream() => Promise<BaseResponse<null>>

Stops a stream if one is currently active.

Returns: Promise<BaseResponse<null>>

Interfaces

BaseResponse

The response wrapper for all response objects

PluginListenerHandle

AudioSessionEvent

Event response for handling audio session notifications

MixerTimeResponse

Response representing HH:MM:SS.ms-formatted time

VolumeMeterEvent

Event response for handling current volume level

PlaybackStateResponse

Response that returns PlayerState

BaseMixerRequest

Base class for all mixer requests, consists of audioId only

IsPlayingResponse

Response for tracking player state as a boolean

VolumeResponse

Response for tracking channel volume

ChannelPropertyRequest

Request to get info about channel properties such as current volume, EQ, etc.

EqResponse

Response for tracking channel EQ

InitResponse

Response for initialization of channel

InitChannelRequest

Request used to initialize a channel on the mixer

AdjustVolumeRequest

For mixer requests manipulating volume level

AdjustEqRequest

For mixer requests manipulating EQ

SetEventRequest

Request to set an event listener

ChannelCountResponse

Response for channel count of requested audio port

InitAudioSessionResponse

Response for initalizing audio session

InitAudioSessionRequest

Request to initialize an audio session

SessionStateResponse

Response that returns PlayerState

DestroyResponse

Response for destroying a channel

FileValidationResponse

Response for validating file path

FileValidationRequest

Request to validate a file path.

StreamRequest

Request to stream audio to provided url

Type Aliases

MixerTimeEvent

Event response for handling current elapsed time

MixerTimeResponse

PlayerState

Possible states of player

"play" | "pause" | "stop" | "not implemented"

Enums

ResponseStatus

AudioSessionHandlerTypes

InputType

EqType

AudioSessionPortType