Class RemoteServer

Media server (UPnP/DLNA) on the network Accessible e.g. via app.sharing.getRemoteServers()

RemoteServer

Hierarchy (view full)

ServerContainer
- RemoteServer

Constructors

constructor

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

baseUrl

baseUrl: string

Base URL of the server

deleted

deleted: boolean

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

descriptionUrl

descriptionUrl: string

URL link to device description

dontNotify

dontNotify: boolean

Undocumented

fullName

fullName: string

Undocumented

iconUrl

iconUrl: string

URL link to device icon

id

id: number

Gets integer id of the object

idColl

idColl: number

Undocumented

ip

ip: string

IP address of this device

isCustom

isCustom: boolean

Whether this server was added manually (isCustom = true) or SSDP auto-discovered (isCustom = false)

isObservable

isObservable: boolean

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

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

itemImageType

itemImageType: string

Undocumented

manufacturer

manufacturer: string

Manufacturer of this server

modelDescription

modelDescription: string

Model description of this server

modelName

modelName: string

Model name of this server

modelNumber

modelNumber: string

Model number of this server

name

name: string

Name of this server

objectType

objectType: string

Gets the object type as string

persistentID

persistentID: string

Gets persistent id of the object

port

port: number

IP port of this device

statusInfo

statusInfo: Promise<any>

Undocumented

supportPin

supportPin: boolean

Whether object support pin to pinned list

title

title: string

Gets the object title

trackType

trackType: number

Undocumented

upnpclass

upnpclass: string

Undocumented

uuid

uuid: string

Undocumented

Methods

addLink

addLink(linkType, linkInfo, link): Promise<any>
Add new external list associated with object.
Parameters
- linkType: string
  Type of a link
- linkInfo: string
  Link information (like release or releaseGroup for musicbrainz link)
- link: string
  Link string
Returns Promise<any>
Inherited from ServerContainer.addLink
- Defined in src/types/Native.ts:980

beginUpdate

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

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

doCut

doCut(data): Promise<any>
Parameters
- data: Base
Returns Promise<any>
Undocumented
Inherited from ServerContainer.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 ServerContainer.endUpdate
- Defined in src/types/Native.ts:282

getAllLinksList

getAllLinksList(): ExternalLinksList
Get all external object links (acoustID, musicbrainz, wikipedia etc.)

Returns ExternalLinksList
Inherited from ServerContainer.getAllLinksList
- Defined in src/types/Native.ts:953

getCachedThumb

getCachedThumb(dimX, dimY): string
Parameters
- dimX: number
- dimY: number
Returns string
Undocumented
Overrides ServerContainer.getCachedThumb
- Defined in src/types/Native.ts:6670

getClassName

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

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

getContainers

getContainers(): SharedUIList<ServerContainer>
Returns SharedUIList<ServerContainer>
Undocumented
Inherited from ServerContainer.getContainers
- Defined in src/types/Native.ts:6549

getLinksList

getLinksList(...params): ExternalLinksList
Get external link associated with the object. All link identifiers are (updated list is available in consts.js) : var LINK_MUSICBRAINZ = 'musicbrainz', LINK_ACOUSTID = 'acoustid', LINK_TVDB = 'tvdb', LINK_MAZE = 'maze', LINK_IMDB = 'imdb', LINK_WIKI = 'wiki', LINK_ECHOPRINT = 'echoprint', LINK_MOVIEDB = 'moviedb', LINK_DISCOGS = 'discogs';
Parameters
- Rest ...params: any[]
Returns ExternalLinksList
Inherited from ServerContainer.getLinksList
- Defined in src/types/Native.ts:971

getPersistentJSON

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

getProperties

getProperties(): string
Gets all properties as single string

Returns string
- Defined in src/types/Native.ts:6649

getThumbAsync

getThumbAsync(...params): number
Returns link to cached image thumbnail of the nearest specified size
Parameters
- Rest ...params: any[]
Returns number
Overrides ServerContainer.getThumbAsync
- Defined in src/types/Native.ts:6669

getTracklist

getTracklist(...params): Tracklist
Parameters
- Rest ...params: any[]
Returns Tracklist
Undocumented
Inherited from ServerContainer.getTracklist
- Defined in src/types/Native.ts:6550

isMarked

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

isPinned

isPinned(): Promise<any>
Object is pinned in pinned list

Returns Promise<any>
Inherited from ServerContainer.isPinned
- Defined in src/types/Native.ts:940

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

makePublicAsync

makePublicAsync(): Promise<any>
Creates public access (to be accessible outside of LAN)

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

modifyAsync

modifyAsync(...params): Promise<any>
Call defined method with the item locked for modifications.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Inherited from ServerContainer.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 ServerContainer.notifyChanged
- Defined in src/types/Native.ts:308

removeAsync

removeAsync(): Promise<any>
Removes the server (can be only when isCustom = true)

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

removeLink

removeLink(...params): Promise<any>
Remove external link from object.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Inherited from ServerContainer.removeLink
- Defined in src/types/Native.ts:989

setMarked

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

setPinned

setPinned(pinned, collID): void
Set object is pinned in pinned list.
Parameters
- pinned: boolean
  Object is pinned
- collID: number
  ID of collection where object is pinned
Returns void
Inherited from ServerContainer.setPinned
- Defined in src/types/Native.ts:947

toString

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

toUriString

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

updateStatus

updateStatus(): void
Returns void
Undocumented
Inherited from ServerContainer.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 RemoteServer

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns RemoteServer

Properties

asJSON

baseUrl

deleted

descriptionUrl

dontNotify

Undocumented

fullName

Undocumented

iconUrl

id

idColl

Undocumented

ip

isCustom

isObservable

isStatusBarSource

itemImageType

Undocumented

manufacturer

modelDescription

modelName

modelNumber

name

objectType

persistentID

port

statusInfo

Undocumented

supportPin

title

trackType

Undocumented

upnpclass

Undocumented

uuid

Undocumented

Methods

addLink

Parameters

Returns Promise<any>

beginUpdate

Returns void

checkUpdate

Parameters

Returns void

doCut

Parameters

Returns Promise<any>

Undocumented

endUpdate

Returns boolean

getAllLinksList

Returns ExternalLinksList

getCachedThumb

Parameters

Returns string

Undocumented

getClassName

Returns string

getContainers

Returns SharedUIList<ServerContainer>

Undocumented

getLinksList

Parameters

Returns ExternalLinksList

getPersistentJSON

Returns string

Undocumented

getProperties