actions | Kokoro API v1.0.0

Index

Interfaces

IAction

Variables

Functions

Variables

Const CLEAR_PLAYLIST

CLEAR_PLAYLIST: "CLEAR_PLAYLIST" = "CLEAR_PLAYLIST"

Const NEXT_SRC

NEXT_SRC: "NEXT_SRC" = "NEXT_SRC"

Const PAUSE

PAUSE: "PAUSE" = "PAUSE"

Const PLAY

PLAY: "PLAY" = "PLAY"

Const SET_BUFFERED_TIME

SET_BUFFERED_TIME: "SET_BUFFERED_TIME" = "SET_BUFFERED_TIME"

Const SET_CURRENT_TIME

SET_CURRENT_TIME: "SET_CURRENT_TIME" = "SET_CURRENT_TIME"

Const SET_PLAYLIST

SET_PLAYLIST: "SET_PLAYLIST" = "SET_PLAYLIST"

Const SET_SPEED

SET_SPEED: "SET_SPEED" = "SET_SPEED"

Const SET_TIMES

SET_TIMES: "SET_TIMES" = "SET_TIMES"

Const SET_TOTAL_TIME

SET_TOTAL_TIME: "SET_TOTAL_TIME" = "SET_TOTAL_TIME"

Const SET_VOLUME

SET_VOLUME: "SET_VOLUME" = "SET_VOLUME"

Const UPDATE_SONG

UPDATE_SONG: "UPDATE_SONG" = "UPDATE_SONG"

Functions

autoNext

autoNext(): ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

- Defined in index.d.ts:160
Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

clearPlaylist

clearPlaylist(): IAction<"CLEAR_PLAYLIST", undefined>

- Defined in index.d.ts:168
Returns IAction<"CLEAR_PLAYLIST", undefined>

next(): ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

- Defined in index.d.ts:159
Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

nextPlayOrder

nextPlayOrder(): ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

- Defined in index.d.ts:163
Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

nextSrc

nextSrc(): IAction<"NEXT_SRC", undefined>

- Defined in index.d.ts:157
Returns IAction<"NEXT_SRC", undefined>

pause

pause(): IAction<"PAUSE", undefined>

- Defined in index.d.ts:151
Returns IAction<"PAUSE", undefined>

play

play(): IAction<"PLAY", undefined>

- Defined in index.d.ts:152
Returns IAction<"PLAY", undefined>

previous(): ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

- Defined in index.d.ts:161
Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

removeSong

removeSong(song: ISong | number | string): ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

- Defined in index.d.ts:166
Parameters
- song: ISong | number | string
Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

setBufferedTime

setBufferedTime(buffered: ITimeRanges): IAction<"SET_BUFFERED_TIME", ITimeRanges>

- Defined in index.d.ts:155
Parameters
- buffered: ITimeRanges
Returns IAction<"SET_BUFFERED_TIME", ITimeRanges>

setCurrentSong

setCurrentSong(song: ISong | number | string): ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

- Defined in index.d.ts:164
Parameters
- song: ISong | number | string
Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

setCurrentTime

setCurrentTime(time: number): IAction<"SET_CURRENT_TIME", number>

- Defined in index.d.ts:153
Parameters
- time: number
Returns IAction<"SET_CURRENT_TIME", number>

setNextSong

setNextSong(song: ISong | number | string): ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

- Defined in index.d.ts:165
Parameters
- song: ISong | number | string
Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

setPlayOrder

setPlayOrder(playOrder: IPlayOrder): ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

- Defined in index.d.ts:162
Parameters
- playOrder: IPlayOrder
Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

setPlaylist

setPlaylist(songs: ISong[], currentSong?: ISong | number | string, playOrder?: IPlayOrder): ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

- Defined in index.d.ts:167
Parameters
- songs: ISong[]
- Optional currentSong: ISong | number | string
- Optional playOrder: IPlayOrder
Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

setSpeed

setSpeed(speedRate: number): IAction<"SET_SPEED", number>

- Defined in index.d.ts:170
Parameters
- speedRate: number
Returns IAction<"SET_SPEED", number>

setTimes

setTimes(times: ITimes): IAction<"SET_TIMES", ITimes>

- Defined in index.d.ts:156
Parameters
- times: ITimes
Returns IAction<"SET_TIMES", ITimes>

setTotalTime

setTotalTime(time: number): IAction<"SET_TOTAL_TIME", number>

- Defined in index.d.ts:154
Parameters
- time: number
Returns IAction<"SET_TOTAL_TIME", number>

setVolume

setVolume(volume: number): IAction<"SET_VOLUME", number>

- Defined in index.d.ts:169
Parameters
- volume: number
Returns IAction<"SET_VOLUME", number>

updateSong

updateSong(song: ISong): IAction<"UPDATE_SONG", ISong>

- Defined in index.d.ts:158
Parameters
- song: ISong
Returns IAction<"UPDATE_SONG", ISong>

Index

Interfaces

Variables

Functions

Variables

Const CLEAR_PLAYLIST

Const NEXT_SRC

Const PAUSE

Const PLAY

Const SET_BUFFERED_TIME

Const SET_CURRENT_TIME

Const SET_PLAYLIST

Const SET_SPEED

Const SET_TIMES

Const SET_TOTAL_TIME

Const SET_VOLUME

Const UPDATE_SONG

Functions

autoNext

Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

clearPlaylist

Returns IAction<"CLEAR_PLAYLIST", undefined>

next

Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

nextPlayOrder

Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

nextSrc

Returns IAction<"NEXT_SRC", undefined>

pause

Returns IAction<"PAUSE", undefined>

play

Returns IAction<"PLAY", undefined>

previous

Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

removeSong

Parameters

song: ISong | number | string

Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

setBufferedTime

Parameters

buffered: ITimeRanges

Returns IAction<"SET_BUFFERED_TIME", ITimeRanges>

setCurrentSong

Parameters

song: ISong | number | string

Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

setCurrentTime

Parameters

time: number

Returns IAction<"SET_CURRENT_TIME", number>

setNextSong

Parameters

song: ISong | number | string

Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

setPlayOrder

Parameters

playOrder: IPlayOrder

Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

setPlaylist

Parameters

songs: ISong[]

Optional currentSong: ISong | number | string

Optional playOrder: IPlayOrder

Returns ThunkAction<undefined, IState, undefined, IAction<"SET_PLAYLIST", IPlaylistState>>

setSpeed

Parameters

speedRate: number

Returns IAction<"SET_SPEED", number>

setTimes

Parameters

times: ITimes

Returns IAction<"SET_TIMES", ITimes>

setTotalTime

Parameters

time: number

Returns IAction<"SET_TOTAL_TIME", number>

setVolume

Parameters

volume: number

Returns IAction<"SET_VOLUME", number>