Difference between revisions of "MJSchemeAutomation"

From JRiverWiki
Jump to: navigation, search
 
Line 1: Line 1:
interface for working with Media Library
+
interface for working with Media Library View Schemes
 
==Functions==
 
==Functions==
 
===string GetName()===
 
===string GetName()===

Revision as of 12:26, 2 July 2007

interface for working with Media Library View Schemes

Functions

string GetName()

Description: gets the name of the scheme item (i.e. "Classic Rock", "Artist\Album", etc.)
Return Value: a string containing the name of the scheme item

number GetNumberSchemes()

Description: gets the number of children schemes
Return Value: number of children schemes

MJSchemeAutomation * GetScheme(number nScheme)

Description: gets the specified child scheme
Parameters:

  • nScheme: the index of the child scheme to retrieve (0 to GetNumberSchemes() - 1)

Return Value: a MJSchemeAutomation interface for the specified child scheme

MJFilesAutomation * GetFiles()

Description: gets the collection of files in the scheme
Return Value: MJFilesAutomation interface of files

string GetSchemeName(number nScheme)

Description: gets the name of the specified child scheme (faster than GetScheme(...))
Parameters:

  • nScheme: the index of the child scheme to retrieve (0 to GetNumberSchemes() - 1)

Return Value: a string containing the name of the child scheme item