Class RemotePlayer

Remote Player (UPnP/DLNA) Accessible e.g. via app.sharing.getAvailablePlayers() or app.sharing.getActivePlayer()

RemotePlayer

Hierarchy (view full)

Constructors

constructor

Properties

asJSON deleted dontNotify id isMultiZone? isObservable isPaused isPlaying isStatusBarSource lengthMS name objectType persistentID players? positionMS statusInfo title totalPlaybackTime uuid volume

Methods

beginUpdate checkUpdate doCut endUpdate getClassName getDeviceType getPersistentJSON isMarked locked modifyAsync next notifyChanged pause play playURI playURIAsync previous setMarked setMute stop toString toUriString updateStatus

Events

event_change event_destroying event_statuschange

Constructors

constructor

Properties

asJSON

asJSON: string

Gets the object as serialized JSON string. Or sets serialized JSON (to fill this object's metadata by the metadata included within the JSON)

deleted

deleted: boolean

Set to true after deletion so that 'change' event is called and item is removed from UI lists.

dontNotify

dontNotify: boolean

Undocumented

id

id: number

Gets integer id of the object

Optional isMultiZone

isMultiZone?: boolean

Undocumented

isObservable

isObservable: boolean

Whether this object can be listened (e.g. for 'change' event)

isPaused

isPaused: boolean

Whether player is paused

isPlaying

isPlaying: boolean

Whether player is playing

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

lengthMS

lengthMS: number

Length (in milliseconds) of the seekbar (current track)

name

name: string

Name of the player/renderer

objectType

objectType: string

Gets the object type as string

persistentID

persistentID: string

Gets persistent id of the object

Optional players

players?: SharedList<RemotePlayer>

Undocumented

positionMS

positionMS: number

Position (in milliseconds) of the seekbar

statusInfo

statusInfo: Promise<any>

Undocumented

title

title: string

Gets the object title

totalPlaybackTime

totalPlaybackTime: number

Undocumented

uuid

uuid: string

Guid of the player/renderer

volume

volume: number

Volume of player/renderer (between 0 and 1)

Methods

beginUpdate

  • beginUpdate(): void

  • Lock object to update state. Events are not called when in update state.

    Returns void

checkUpdate

  • checkUpdate(interval): void

  • Updates the object every X ms when called periodically. Useful e.g. when filling lists. Can be used only in the update lock! (i.e. between beginUpdate/endUpdate)

    Parameters

    • interval: number

    Returns void

doCut

  • doCut(data): Promise<any>

  • Parameters

    Returns Promise<any>

    Undocumented

endUpdate

  • endUpdate(): boolean

  • Unlock object from update state. beginUpdate and endUpdate must be in pair. When endUpdate is called, change event is called.

    Returns boolean

getClassName

  • getClassName(): string

  • Gets class name of the object.

    Returns string

getDeviceType

  • getDeviceType(): string

  • Returns string

    Undocumented

getPersistentJSON

isMarked

  • isMarked(id): boolean

  • Parameters

    • id: number

    Returns boolean

    Undocumented

locked

  • locked(func): void

  • Call defined method with locked data so user can access them.

    Parameters

    • func: (() => any)

      Method to call

        • (): any

        • Returns any

    Returns void

modifyAsync

  • modifyAsync(...params): Promise<any>

  • Call defined method with the item locked for modifications.

    Parameters

    • Rest ...params: any[]

    Returns Promise<any>

next

  • next(): void

  • Perform Next on the player

    Returns void

notifyChanged

  • notifyChanged(...params): void

  • Notifies that the object was changed (e.g. to force visual update etc.)

    Parameters

    • Rest ...params: any[]

    Returns void

pause

  • pause(): void

  • Perform Pause on the player

    Returns void

play

  • play(): void

  • Perform Play on the player (e.g. to resume playback)

    Returns void

playURI

  • playURI(aURI, SD, StartPos): number

  • Perform Play on the player (e.g. to resume playback)

    Parameters

    • aURI: string
    • SD: Track
    • StartPos: number

    Returns number

    result -1 = failure, 0 = success

playURIAsync

  • playURIAsync(URI, SD): void

  • Parameters

    Returns void

    Undocumented

previous

  • previous(): void

  • Perform Previous on the player

    Returns void

setMarked

  • setMarked(id, value): void

  • Parameters

    • id: number
    • value: boolean

    Returns void

    Undocumented

setMute

  • setMute(Value): void

  • Parameters

    • Value: boolean

    Returns void

    Undocumented

stop

  • stop(): void

  • Perform Stop on the player

    Returns void

toString

toUriString

updateStatus

Events

event_change

event_change: ((changeType, ...additionalArgs) => void)

Event is called when object is somehow changed

See App.listen

Type declaration

    • (changeType, ...additionalArgs): void

    • Parameters

      • changeType: string

        additional change type (can have values like 'tracklist', 'deleted', 'title' or undefined)

      • Rest ...additionalArgs: any[]

      Returns void

Example

app.listen(object, 'change', (changeType) => {  });

event_destroying

event_destroying: (() => void)

Event is called when object is going to destroy

See App.listen

Type declaration

    • (): void

    • Returns void

event_statuschange

event_statuschange: (() => void)

Event is called when status info of the object is changed

See App.listen

Type declaration

    • (): void

    • Returns void

Download
Forum
Support
Addons
Develop

Settings

Member Visibility

Theme

© 2000-2024 Ventis Media Inc.Generated using TypeDoc