James: 1 revision

2021-01-13T17:25:00Z

1 revision

Jitterjames: Created page with "Go to the main '''Plugins''' page. Go to the complete '''Plugin List'''. For general information see MediaBrowser =Plugin Description= Control and query MB3 se..."

2015-02-02T14:28:00Z

Created page with "Go to the main '''Plugins''' page. Go to the complete '''Plugin List'''. For general information see MediaBrowser =Plugin Description= Control and query MB3 se..."

New page

Go to the main '''[[Plugins]]''' page.

Go to the complete '''[[Plugin List]]'''.

For general information see [[MediaBrowser]]

=Plugin Description=

Control and query MB3 server and clients.

=Actions for the MB3 plugin=
==Browse==
[[MB3.Browse]] 
Instructs the current client to browse to the item with the ID <ItemID>.

* Parameters: 1
#ItemID : MB3 item ID string [''string'']
==GenXML==
[[MB3.GenXML]] 
Generates a payloadXML file for all MB3 media. The file is saved in the MB3Payloads folder.
==GenXmlMusic==
[[MB3.GenXmlMusic]] 
Generates a payloadXML file for all MB3 music. The file is saved in the MB3Payloads folder.
==GenXmlOther==
[[MB3.GenXmlOther]] 
Generates a payloadXML file for all MB3 media except for music. The file is saved in the MB3Payloads folder.
==GeneralCommand==
[[MB3.GeneralCommand]] 
Generally used for simple messages to the client, such as MoveUp, PageDown, NextLetter, Back, TakeScreenshot, VolumeUp, GoHome, Mute, GoToSearch, etc. See "General Commands" at: https://github.com/MediaBrowser/MediaBrowser/wiki/Web-Socket In the case of some general commands that take parameters,we've already created VoxCommando actions to make it easier. 

* Parameters: 1-3
#Command : [''string'']
#ArgumentName : [''string'']
#ArgumentValue : [''string'']
==GetnowPlaying==
[[MB3.GetnowPlaying]] 
If <Format> is omitted then it will return all now playing information in a json string. This can be used to find the data structure and the variables available. Otherwise a string will be returned based on parsing the <Format> string to replace variables enclosed in { } . Example: This is: {Name}, from the album {Album}, by {Artists[[, ]]}, which was recorded in {ProductionYear}. Audio codec is {MediaStreams[0].Codec}. Bitrate is {MediaStreams[0].BitRate} recorded in {MediaStreams[0].ChannelLayout}

* Parameters: 0-1
#Format : See description [''string'']
==PlayItem==
[[MB3.PlayItem]] 
Instructs the current client to play item with the ID <ItemID>. <PlayType> is optional (default = Now) and can be one of the following: InstantMix, Last, Next, Now, Shuffle

* Parameters: 1-2
#ItemID : MB3 item ID string [''string'']
#PlayType : InstantMix, Last, Next, Now, Shuffle [''string'']
==ResumeItem==
[[MB3.ResumeItem]] 
Instructs the current client to resume playback of item with the ID <ItemID>. Playback will resume wherever it was last stopped. This is usually used with Movies and TV Shows.

* Parameters: 1
#ItemID : MB3 item ID string [''string'']
==PlayMusicGenre==
[[MB3.PlayMusicGenre]] 
Queues up and plays music of genre <GenreName>. If <Limit> is omitted, it will play all music of that genre. Note: In the future it may be possible to play a genre using the PlayItem action, but currently MediaBrowser doesn't support this.

* Parameters: 1-2
#GenreName : Name of the genre to play (NOT THE GENRE ID) [''string'']
#Limit : Maximum number of items to queue [''integer'']
==PlayMusicArtist==
[[MB3.PlayMusicArtist]] 
DEPRECATED. This action is no longer needed if you're using the latest version of the MB3 server. Use the PlayItem action instead.

* Parameters: 1-2
#ArtistID : Library ID of the artist to play [''string'']
#Limist : Maximum number of items to Queue [''integer'']
==Playstate==

===NextTrack===
[[MB3.Playstate.NextTrack]] 

* Parameters: 0-1
#Wait : Default = False (asynchronous) [''boolean'']
===PreviousTrack===
[[MB3.Playstate.PreviousTrack]] 

===Stop===
[[MB3.Playstate.Stop]] 

===Pause===
[[MB3.Playstate.Pause]] 

===Unpause===
[[MB3.Playstate.Unpause]] 

===FastForward===
[[MB3.Playstate.FastForward]] 

===Rewind===
[[MB3.Playstate.Rewind]] 

==Seek==
[[MB3.Seek]] 
Seeks in the current file to the specified <SeekTo> percentage. SeekTo should be an integer from 0 to 100.

* Parameters: 1
#SeekTo : 0-100 [''integer'']
==SetClient==
[[MB3.SetClient]] 
Sets (connects to) whichever client you want to control with VoxCommando. Client must already be connected to MB server. Either device, or client, or both can be specified. See wiki for more information.

* Parameters: 1-2
#Device : Name of device to control [''string'']
#Client : Name of client to control [''string'']

← Older revision	Revision as of 17:25, 13 January 2021
(No difference)

Plugin MB3 - Revision history

James: 1 revision

Jitterjames: Created page with "Go to the main '''Plugins''' page. Go to the complete '''Plugin List'''. For general information see MediaBrowser =Plugin Description= Control and query MB3 se..."