Class RemoteClient

Rmote client device (UPnP/DLNA) Accessible e.g. via MediaServer.getClientList()

RemoteClient

Hierarchy (view full)

SharedObservable
- RemoteClient

Constructors

constructor

new RemoteClient(): RemoteClient
Returns RemoteClient
Inherited from SharedObservable.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)

autoConvertConfig

autoConvertConfig: AutoConvertSettings

Auto-convert rules config

customizeContent

customizeContent: boolean

Whether this client customizes the shared content

customizeConversion

customizeConversion: boolean

Whether this client customizes the auto-convert settings

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

enabled

enabled: boolean

Whether this client is enabled to share with

id

id: number

Gets integer id of the object

ip

ip: string

IP of this client (as configured)

isObservable

isObservable: boolean

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

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

lastAccess

lastAccess: string

The last access time of the client

mac

mac: string

IP of this client

name

name: string

Name of this client

objectType

objectType: string

Gets the object type as string

persistentID

persistentID: string

Gets persistent id of the object

server

server: MediaServer

Undocumented

statusInfo

statusInfo: Promise<any>

Undocumented

title

title: string

Gets the object title

Methods

beginUpdate

beginUpdate(): void
Lock object to update state. Events are not called when in update state.

Returns void
Inherited from SharedObservable.beginUpdate
- Defined in src/types/Native.ts:276

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
Inherited from SharedObservable.checkUpdate
- Defined in src/types/Native.ts:288

commitAsync

commitAsync(): Promise<any>
Commits into database

Returns Promise<any>
- Defined in src/types/Native.ts:6745

doCut

doCut(data): Promise<any>
Parameters
- data: Base
Returns Promise<any>
Undocumented
Inherited from SharedObservable.doCut
- Defined in src/types/Native.ts:213

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
Inherited from SharedObservable.endUpdate
- Defined in src/types/Native.ts:282

getClassName

getClassName(): string
Gets class name of the object.

Returns string
Inherited from SharedObservable.getClassName
- Defined in src/types/Native.ts:198

getPersistentJSON

getPersistentJSON(): string
Returns string
Undocumented
Inherited from SharedObservable.getPersistentJSON
- Defined in src/types/Native.ts:214

getSharedObjects

getSharedObjects(): SharedList<SharedObject>
Gets list of objects to be shared (collections, playlists)

Returns SharedList<SharedObject>
- Defined in src/types/Native.ts:6729

isMarked

isMarked(id): boolean
Parameters
- id: number
Returns boolean
Undocumented
Inherited from SharedObservable.isMarked
- Defined in src/types/Native.ts:212

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
Inherited from SharedObservable.locked
- Defined in src/types/Native.ts:192

modifyAsync

modifyAsync(...params): Promise<any>
Call defined method with the item locked for modifications.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Inherited from SharedObservable.modifyAsync
- Defined in src/types/Native.ts:262

notifyChanged

notifyChanged(...params): void
Notifies that the object was changed (e.g. to force visual update etc.)
Parameters
- Rest ...params: any[]
Returns void
Inherited from SharedObservable.notifyChanged
- Defined in src/types/Native.ts:308

removeAsync

removeAsync(): Promise<any>
Removes from database

Returns Promise<any>
- Defined in src/types/Native.ts:6740

setMarked

setMarked(id, value): void
Parameters
- id: number
- value: boolean
Returns void
Undocumented
Inherited from SharedObservable.setMarked
- Defined in src/types/Native.ts:211

setSharedObjects

setSharedObjects(list): void
Sets list of objects to be shared (collections, playlists)
Parameters
- list: SharedList<SharedObject>
  of shared objects
Returns void
- Defined in src/types/Native.ts:6735

toString

toString(): string
Returns string
Undocumented
Inherited from SharedObservable.toString
- Defined in src/types/Native.ts:264

toUriString

toUriString(): string
Returns string
Undocumented
Inherited from SharedObservable.toUriString
- Defined in src/types/Native.ts:263

updateStatus

updateStatus(): void
Returns void
Undocumented
Inherited from SharedObservable.updateStatus
- Defined in src/types/Native.ts:297

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

Class RemoteClient

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns RemoteClient

Properties

asJSON

autoConvertConfig

customizeContent

customizeConversion

deleted

dontNotify

Undocumented

enabled

id

ip

isObservable

isStatusBarSource

lastAccess

mac

name

objectType

persistentID

server

Undocumented

statusInfo

Undocumented

title

Methods

beginUpdate

Returns void

checkUpdate

Parameters

Returns void

commitAsync

Returns Promise<any>

doCut

Parameters

Returns Promise<any>

Undocumented

endUpdate

Returns boolean

getClassName

Returns string

getPersistentJSON

Returns string

Undocumented

getSharedObjects

Returns SharedList<SharedObject>

isMarked

Parameters

Returns boolean

Undocumented

locked

Parameters

Returns any

Returns void

modifyAsync

Parameters

Returns Promise<any>

notifyChanged

Parameters

Returns void

removeAsync

Returns Promise<any>

setMarked

Parameters

Returns void

Undocumented

setSharedObjects

Parameters

Returns void

toString

Returns string

Undocumented