Interface SMPPlman

Public surface installed onto window.plman. Async methods return Promise<...>; sync helpers read from the cache.

Wrapper classes (FbMetadbHandleList etc.) are referenced as unknown to keep the type self-contained; the runtime IIFE installs the concrete classes onto window.* so theme code that types them via global ambient declarations continues to work unchanged.

interface SMPPlman {
    ActivePlaylist: number;
    PlaybackOrder: number;
    PlayingPlaylist: number;
    PlaylistCount: number;
    AddItemToPlaybackQueue(handleLike: SmpHandleLike): Promise<number>;
    AddLocations(
        playlistIdx: number,
        locations: string[] | Iterable<string, any, any>,
        select?: boolean,
    ): Promise<number>;
    AddPlaylistItemToPlaybackQueue?(
        playlistIdx: number,
        playlistItemIdx: number,
    ): Promise<boolean>;
    ClearPlaylist(playlistIdx: number): Promise<boolean>;
    ClearPlaylistSelection(playlistIdx: number): Promise<boolean>;
    CreateAutoPlaylist(
        playlistIdx: number,
        name: string,
        query: string,
        sort?: string,
        flags?: number,
    ): Promise<number>;
    CreatePlaylist(position: number, name: string): Promise<number>;
    DuplicatePlaylist(from: number, name?: string): Promise<number>;
    FindOrCreatePlaylist?(name: string, unlocked?: boolean): Promise<number>;
    FindPlaylist(name: string): number;
    FlushPlaybackQueue(): Promise<boolean>;
    GetPlaybackQueueContents(): Promise<SmpPlaybackQueueItem[]>;
    GetPlaybackQueueHandles?(): Promise<FbMetadbHandleList>;
    GetPlaylistFocusItemIndex(playlistIdx: number): Promise<number>;
    GetPlaylistItems(playlistIdx: number): Promise<FbMetadbHandleList>;
    GetPlaylistName(playlistIdx: number): string;
    GetPlaylistSelectedItems(playlistIdx: number): Promise<FbMetadbHandleList>;
    InsertPlaylistItems(
        playlistIdx: number,
        base: number,
        handles: unknown,
        select?: boolean,
    ): Promise<number>;
    IsAutoPlaylist(playlistIdx: number): boolean;
    IsPlaylistItemSelected?(
        playlistIdx: number,
        itemIdx: number,
    ): Promise<boolean>;
    IsPlaylistLocked(playlistIdx: number): boolean;
    MovePlaylist?(from: number, to: number): Promise<boolean>;
    MovePlaylistSelection(playlistIdx: number, delta: number): Promise<boolean>;
    PlaylistItemCount(playlistIdx: number): number;
    RemovePlaylist(playlistIdx: number): Promise<boolean>;
    RemovePlaylistSelection(
        playlistIdx: number,
        crop?: boolean,
    ): Promise<boolean>;
    RenamePlaylist(playlistIdx: number, name: string): Promise<boolean>;
    SetPlaylistFocusItem(
        playlistIdx: number,
        itemIndex: number,
    ): Promise<boolean>;
    SetPlaylistSelection(
        playlistIdx: number,
        indices: number[] | Iterable<number, any, any>,
        state: boolean,
    ): Promise<boolean>;
    SortByFormat(
        playlistIdx: number,
        pattern: string,
        selectedOnly?: boolean,
    ): Promise<boolean>;
    UndoBackup(playlistIdx: number): boolean | Promise<boolean>;
}

Properties

ActivePlaylist

ActivePlaylist: number

PlaybackOrder

PlaybackOrder: number

`Readonly`PlayingPlaylist

PlayingPlaylist: number

`Readonly`PlaylistCount

PlaylistCount: number

Methods

AddItemToPlaybackQueue

AddItemToPlaybackQueue(handleLike: SmpHandleLike): Promise<number>
Parameters
- handleLike: SmpHandleLike
Returns Promise<number>
- Defined in sdk/src/smp/types.ts:307

AddLocations

AddLocations(
    playlistIdx: number,
    locations: string[] | Iterable<string, any, any>,
    select?: boolean,
): Promise<number>
Parameters
- playlistIdx: number
- locations: string[] | Iterable<string, any, any>
- Optionalselect: boolean
Returns Promise<number>
- Defined in sdk/src/smp/types.ts:301

`Optional`AddPlaylistItemToPlaybackQueue

AddPlaylistItemToPlaybackQueue?(
playlistIdx: number,
playlistItemIdx: number,
): Promise<boolean>
Parameters
- playlistIdx: number
- playlistItemIdx: number
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:308

ClearPlaylist

ClearPlaylist(playlistIdx: number): Promise<boolean>
Parameters
- playlistIdx: number
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:258

ClearPlaylistSelection

ClearPlaylistSelection(playlistIdx: number): Promise<boolean>
Parameters
- playlistIdx: number
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:275

CreateAutoPlaylist

CreateAutoPlaylist(
    playlistIdx: number,
    name: string,
    query: string,
    sort?: string,
    flags?: number,
): Promise<number>
Parameters
- playlistIdx: number
- name: string
- query: string
- Optionalsort: string
- Optionalflags: number
Returns Promise<number>
- Defined in sdk/src/smp/types.ts:293

CreatePlaylist

CreatePlaylist(position: number, name: string): Promise<number>
Parameters
- position: number
- name: string
Returns Promise<number>
- Defined in sdk/src/smp/types.ts:256

DuplicatePlaylist

DuplicatePlaylist(from: number, name?: string): Promise<number>
Parameters
- from: number
- Optionalname: string
Returns Promise<number>
- Defined in sdk/src/smp/types.ts:300

`Optional`FindOrCreatePlaylist

FindOrCreatePlaylist?(name: string, unlocked?: boolean): Promise<number>
Parameters
- name: string
- Optionalunlocked: boolean
Returns Promise<number>
- Defined in sdk/src/smp/types.ts:317

FindPlaylist

FindPlaylist(name: string): number
Parameters
- name: string
Returns number
- Defined in sdk/src/smp/types.ts:250

FlushPlaybackQueue

FlushPlaybackQueue(): Promise<boolean>
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:312

GetPlaybackQueueContents

GetPlaybackQueueContents(): Promise<SmpPlaybackQueueItem[]>
Returns Promise<SmpPlaybackQueueItem[]>
- Defined in sdk/src/smp/types.ts:313

`Optional`GetPlaybackQueueHandles

GetPlaybackQueueHandles?(): Promise<FbMetadbHandleList>
Returns Promise<FbMetadbHandleList>
- Defined in sdk/src/smp/types.ts:314

GetPlaylistFocusItemIndex

GetPlaylistFocusItemIndex(playlistIdx: number): Promise<number>
Parameters
- playlistIdx: number
Returns Promise<number>
- Defined in sdk/src/smp/types.ts:267

GetPlaylistItems

GetPlaylistItems(playlistIdx: number): Promise<FbMetadbHandleList>
Returns an FbMetadbHandleList instance at runtime.
Parameters
- playlistIdx: number
Returns Promise<FbMetadbHandleList>
- Defined in sdk/src/smp/types.ts:261

GetPlaylistName

GetPlaylistName(playlistIdx: number): string
Parameters
- playlistIdx: number
Returns string
- Defined in sdk/src/smp/types.ts:248

GetPlaylistSelectedItems

GetPlaylistSelectedItems(playlistIdx: number): Promise<FbMetadbHandleList>
Returns an FbMetadbHandleList instance at runtime.
Parameters
- playlistIdx: number
Returns Promise<FbMetadbHandleList>
- Defined in sdk/src/smp/types.ts:263

InsertPlaylistItems

InsertPlaylistItems(
    playlistIdx: number,
    base: number,
    handles: unknown,
    select?: boolean,
): Promise<number>
Parameters
- playlistIdx: number
- base: number
- handles: unknown
- Optionalselect: boolean
Returns Promise<number>
- Defined in sdk/src/smp/types.ts:277

IsAutoPlaylist

IsAutoPlaylist(playlistIdx: number): boolean
Parameters
- playlistIdx: number
Returns boolean
- Defined in sdk/src/smp/types.ts:251

`Optional`IsPlaylistItemSelected

IsPlaylistItemSelected?(playlistIdx: number, itemIdx: number): Promise<boolean>
Parameters
- playlistIdx: number
- itemIdx: number
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:316

IsPlaylistLocked

IsPlaylistLocked(playlistIdx: number): boolean
Parameters
- playlistIdx: number
Returns boolean
- Defined in sdk/src/smp/types.ts:252

`Optional`MovePlaylist

MovePlaylist?(from: number, to: number): Promise<boolean>
Parameters
- from: number
- to: number
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:318

MovePlaylistSelection

MovePlaylistSelection(playlistIdx: number, delta: number): Promise<boolean>
Parameters
- playlistIdx: number
- delta: number
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:291

PlaylistItemCount

PlaylistItemCount(playlistIdx: number): number
Parameters
- playlistIdx: number
Returns number
- Defined in sdk/src/smp/types.ts:249

RemovePlaylist

RemovePlaylist(playlistIdx: number): Promise<boolean>
Parameters
- playlistIdx: number
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:257

RemovePlaylistSelection

RemovePlaylistSelection(playlistIdx: number, crop?: boolean): Promise<boolean>
Parameters
- playlistIdx: number
- Optionalcrop: boolean
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:283

RenamePlaylist

RenamePlaylist(playlistIdx: number, name: string): Promise<boolean>
Parameters
- playlistIdx: number
- name: string
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:255

SetPlaylistFocusItem

SetPlaylistFocusItem(playlistIdx: number, itemIndex: number): Promise<boolean>
Parameters
- playlistIdx: number
- itemIndex: number
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:268

SetPlaylistSelection

SetPlaylistSelection(
    playlistIdx: number,
    indices: number[] | Iterable<number, any, any>,
    state: boolean,
): Promise<boolean>
Parameters
- playlistIdx: number
- indices: number[] | Iterable<number, any, any>
- state: boolean
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:270

SortByFormat

SortByFormat(
    playlistIdx: number,
    pattern: string,
    selectedOnly?: boolean,
): Promise<boolean>
Parameters
- playlistIdx: number
- pattern: string
- OptionalselectedOnly: boolean
Returns Promise<boolean>
- Defined in sdk/src/smp/types.ts:285

UndoBackup

UndoBackup(playlistIdx: number): boolean | Promise<boolean>
Parameters
- playlistIdx: number
Returns boolean | Promise<boolean>
- Defined in sdk/src/smp/types.ts:290

Interface SMPPlman

Index

Properties

Methods

Properties

ActivePlaylist

PlaybackOrder

ReadonlyPlayingPlaylist

ReadonlyPlaylistCount

Methods

AddItemToPlaybackQueue

Parameters

Returns Promise<number>

AddLocations

Parameters

Returns Promise<number>

OptionalAddPlaylistItemToPlaybackQueue

Parameters

Returns Promise<boolean>

ClearPlaylist

Parameters

Returns Promise<boolean>

ClearPlaylistSelection

Parameters

Returns Promise<boolean>

CreateAutoPlaylist

Parameters

Returns Promise<number>

CreatePlaylist

Parameters

Returns Promise<number>

DuplicatePlaylist

Parameters

Returns Promise<number>

OptionalFindOrCreatePlaylist

Parameters

Returns Promise<number>

FindPlaylist

Parameters

Returns number

FlushPlaybackQueue

Returns Promise<boolean>

GetPlaybackQueueContents

Returns Promise<SmpPlaybackQueueItem[]>

OptionalGetPlaybackQueueHandles

Returns Promise<FbMetadbHandleList>

GetPlaylistFocusItemIndex

Parameters

Returns Promise<number>

GetPlaylistItems

Parameters

Returns Promise<FbMetadbHandleList>

GetPlaylistName

Parameters

Returns string

GetPlaylistSelectedItems

Parameters

Returns Promise<FbMetadbHandleList>

InsertPlaylistItems

Parameters

Returns Promise<number>

IsAutoPlaylist

Parameters

Returns boolean

OptionalIsPlaylistItemSelected

Parameters

Returns Promise<boolean>

IsPlaylistLocked

Parameters

Returns boolean

OptionalMovePlaylist

Parameters

Returns Promise<boolean>

MovePlaylistSelection

Parameters

Returns Promise<boolean>

PlaylistItemCount

Parameters

Returns number

RemovePlaylist

`Readonly`PlayingPlaylist

`Readonly`PlaylistCount

`Optional`AddPlaylistItemToPlaybackQueue

`Optional`FindOrCreatePlaylist

`Optional`GetPlaybackQueueHandles

`Optional`IsPlaylistItemSelected

`Optional`MovePlaylist