Media source members¶

• Media source members
• Dictionary<string, IMediaSource> Sources { get; }
• Dictionary<string, float> GetUploadAmounts();
• Dictionary<string, float> GetDownloadAmounts();
• void AddSource(string preferredAlias, string source, bool local);
• void DisplayMediaSource(string targetElement, int materialGroupId, string alias);
• void RemoveMediaSource(string alias);
• void SaveMediaSource(string alias);
• Comments

Dictionary<string, IMediaSource> Sources { get; }¶

Returns- a dictionary mapping media source aliases to media sources.

Dictionary<string, float> GetUploadAmounts();¶

Returns- a dictonary mapping media source alias to upload percentage.

Dictionary<string, float> GetDownloadAmounts();¶

Returns- a dictonary mapping media source alias to download percentage.

void AddSource(string preferredAlias, string source, bool local);¶

Description- Adds a media source to the plugin based on the given parameters.
'preferredAlias'- The desired alias for the media source. This may be renamed if there is a naming conflict.
'source'- An absolute path to the media file to create the media source with.
'local'- 'true' if the 'source' path is local to the client, 'false' if it remote.

Example lua usage

   -- Add a local image file
   mediascreenplugin:addsource('cool picture', 'C:\\Users\\John Citizen\\photo.jpg', true)

   -- Add a remote web page
   mediascreenplugin:addsource('cooler web page', 'www.coolest_page_ever.com', false)

void DisplayMediaSource(string targetElement, int materialGroupId, string alias);¶

Description- Displays the source with the given 'alias' on the screen controller with matching 'targetElement' and 'materialGroupId'
'targetElement'- The element that the target screen controller is targeting.
'materialGroupId'- The material group id the target screen controller is targeting.
'alias'- The alias of an already added media source to display on the target screen controller.

void RemoveMediaSource(string alias);¶

Description- Removes the given media source from the plugin. This will remove the file from all displays, all connected clients and the server.
'alias'- The alias of the media source to remove.

void SaveMediaSource(string alias);¶

Description- Allows user to save the media source to disk. This can vary between media source types, but usually with by done by a save file dialog.
'alias'- The alias of the media source to save.