MJViewItemAutomation: Difference between revisions

From wiki.jriver.com
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
Line 60: Line 60:
'''Description:''' not implemented<br>
'''Description:''' not implemented<br>
'''Return Value:''' FALSE
'''Return Value:''' FALSE

[[Category:COM Automation]]

Latest revision as of 05:40, 4 May 2015

interface for creating / walking the Media Center tree structure

Functions

string GetName()

Description: gets the name of this item
Return Value: the name of the item

string GetFullName()

Description: gets the full name of this item (the whole path -- backslash delimited -- i.e. Media Library\Audio\Artist/Album\Bob Dylan)
Return Value: the full name of the item

MJFilesAutomation * GetFiles()

Description: gets the files associated with the current item
Return Value: MJFilesAutomation interface

void DoCommand(number nParam)

Description: performs the command associated with the current item (play / show, playing now command, etc.)
Parameters:

  • nParam: for future use -- must be zero

number GetNumberChildren()

Description: gets the number of child items
Return Value: the number of children

string GetChildName(number nIndex)

Description: gets the name of a child item
Parameters:

  • nIndex: the index of the child item (0 to GetNumberChildren() - 1)

Return Value: the name of the child item

MJViewItemAutomation * GetChild(number nIndex)

Description: gets the MJViewItemAutomation interface (see below) for the given child index
Parameters:

  • nIndex: the index of the child to retrieve (0 to GetNumberChildren() - 1)

Return Value: MJViewItemAutomation interface

boolean GetChildHasChildren(number nIndex)

Description: gets the name of a child item
Parameters:

  • nIndex: the index of the child item (0 to GetNumberChildren() - 1)

Return Value: whether the specified child has children of its own

MJViewItemAutomation * GetParent()

Description: gets the parent item
Return Value: MJViewItemAutomation interface

string GetThumbnailFilenames(number nThumbnailSize, number nMaxCount)

Description: not implemented
Parameters:

  • nThumbnailSize: N/A
  • nMaxCount: N/A

Return Value: N/A

boolean GetChildIsFolder(number nIndex)

Description: determine if the specified child contains sub-view items
Parameters:

  • nIndex: the number of the child

Return Value: true only if the child contains sub-view items

boolean GetIsSearch()

Description: not implemented
Return Value: FALSE