Class Sharing

Class to handle/manage media sharing (UPnP/DLNA) Accessible via app.sharing

Hierarchy

Sharing

Constructors

constructor

new Sharing(): Sharing
Returns Sharing

Methods

addFirewallException

addFirewallException(add): void
Undocumented
Parameters
- add: boolean
Returns void
- Defined in src/types/Native.ts:7053

addRemoteServerAsync

addRemoteServerAsync(DescriptionURL): Promise<any>
Adds manually a remote server to browse/play content from, is useful when the server cannot be auto-discovered (e.g. is located outside of LAN)
Parameters
- DescriptionURL: string
Returns Promise<any>
- Defined in src/types/Native.ts:6991

createMetadataStorageHandler

createMetadataStorageHandler(profile_id): MetadataStorageHandler
Undocumented
Parameters
- profile_id: string
Returns MetadataStorageHandler
- Defined in src/types/Native.ts:7050

createNewServer

createNewServer(): MediaServer
Creates new server with default values

Returns MediaServer
- Defined in src/types/Native.ts:7022

getActivePlayer

getActivePlayer(): RemotePlayer
Gets active remote player (to be controlled by MediaMonkey player)

Returns RemotePlayer
- Defined in src/types/Native.ts:7010

getAuthReceiver

getAuthReceiver(): AuthReceiver
Undocumented

Returns AuthReceiver
- Defined in src/types/Native.ts:7046

getAuthServerPort

getAuthServerPort(): string
Undocumented

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

getAvailablePlayers

getAvailablePlayers(): SharedList<RemotePlayer>
Gets the list of available players on the LAN (list of RemotePlayer class)

Returns SharedList<RemotePlayer>
- Defined in src/types/Native.ts:6997

getClientForPlayerAsync

getClientForPlayerAsync(player): Promise<any>
Undocumented
Parameters
- player: RemotePlayer
Returns Promise<any>
- Defined in src/types/Native.ts:7016

getCollectionSubnodes

getCollectionSubnodes(CollID): SharedUIList<ListItem>
Undocumented
Parameters
- CollID: number
Returns SharedUIList<ListItem>
- Defined in src/types/Native.ts:7054

getIsInitialized

getIsInitialized(): boolean
Undocumented

Returns boolean
- Defined in src/types/Native.ts:7052

getMultiZonePlayers

getMultiZonePlayers(): SharedList<RemotePlayer>
Gets the list of available players that are configured for multi zone playback

Returns SharedList<RemotePlayer>
- Defined in src/types/Native.ts:7003

getRemoteServers

getRemoteServers(...params): SharedUIList<RemoteServer>
Gets the list of available servers on the LAN (list of RemoteServer class) plus those manually added via app.sharing.addRemoteServerAsync()
Parameters
- Rest ...params: any[]
Returns SharedUIList<RemoteServer>
- Defined in src/types/Native.ts:6984

getServerContainerFromJSON

getServerContainerFromJSON(JSON): ServerContainer
Undocumented
Parameters
- JSON: string
Returns ServerContainer
- Defined in src/types/Native.ts:7051

getServers

getServers(): ServerList
Gets the configured MediaMonkey server list (list of MediaServer class)

Returns ServerList
- Defined in src/types/Native.ts:6977

getServieIsInstalled

getServieIsInstalled(): Promise<any>
Returns whether service for MediaMonkey is installed

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

installService

installService(username, password): Promise<any>
Installs service for MediaMonkey allowing to browse media server even if MediaMonkey is not running (and not logged into the user account).
Parameters
- username: string
- password: string
Returns Promise<any>
- Defined in src/types/Native.ts:7037

runAuthServer

runAuthServer(): Promise<any>
Undocumented

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

setActivePlayerUUID

setActivePlayerUUID(uuid): Promise<any>
Sets active remote player (to be controlled by MediaMonkey player) by its UUID, empty value sets to 'local' player
Parameters
- uuid: string
Returns Promise<any>
- Defined in src/types/Native.ts:7015

setMultiZoneUUID

setMultiZoneUUID(uuid, enabled): void
Undocumented
Parameters
- uuid: string
- enabled: boolean
Returns void
- Defined in src/types/Native.ts:7004

setPlayerControlAllowed

setPlayerControlAllowed(value): void
Allows/disallows remote control of MediaMonkey player via UPnP/DLNA
Parameters
- value: boolean
Returns void
- Defined in src/types/Native.ts:7027

start

start(): void
Starts sharing (runs configured media servers)

Returns void
- Defined in src/types/Native.ts:7031

stopAuthServer

stopAuthServer(): void
Undocumented

Returns void
- Defined in src/types/Native.ts:7048

uninstallService

uninstallService(): Promise<any>
Uninstalls service for MediaMonkey

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