![]() |
Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
Classes | |
struct | ResumeInformation |
Enumerations | |
enum class | QueuePosition { POSITION_BEGIN , POSITION_END } |
Functions | |
void | PlayItem (const std::shared_ptr< CFileItem > &item, const std::string &player, ContentUtils::PlayMode mode=ContentUtils::PlayMode::CHECK_AUTO_PLAY_NEXT_ITEM) |
Start playback of the given item. If the item is a folder, build a playlist with all items contained in the folder and start playback of the playlist. If item is a single video item, start playback directly, without adding it to the video playlist first. | |
void | QueueItem (const std::shared_ptr< CFileItem > &item, QueuePosition pos) |
Queue the given item in the currently active playlist. If no playlist is active, put the item into the video playlist. | |
bool | GetItemsForPlayList (const std::shared_ptr< CFileItem > &item, CFileItemList &queuedItems) |
For a given item, get the items to put in a playlist. If the item is a folder, all subitems will be added recursively to the returned item list. If the item is a playlist, the playlist will be loaded and contained items will be added to the returned item list. Shows a busy dialog if action takes certain amount of time to give the user visual feedback. | |
bool | IsItemPlayable (const CFileItem &item) |
Check whether the given item can be played by the app playlist player as one or more videos. | |
bool | HasItemVideoDbInformation (const CFileItem &item) |
Check whether for the given item information is stored in the video database. | |
std::string | GetResumeString (const CFileItem &item) |
Get a localized resume string for the given item, if it is resumable. | |
std::string | GetOpticalMediaPath (const CFileItem &item) |
Check whether an item is an optical media folder or its parent. This will return the non-empty path to the playable entry point of the media one or two levels down (VIDEO_TS.IFO for DVDs or index.bdmv for BDs). The returned path will be empty if folder does not meet this criterion. | |
bool | IsAutoPlayNextItem (const CFileItem &item) |
Check whether auto play next item is set for the media type of the given item. | |
bool | IsAutoPlayNextItem (const std::string &content) |
Check whether auto play next item is set for the given content type. | |
ResumeInformation | GetItemResumeInformation (const CFileItem &item) |
Check whether playback of the given item can be resumed, get detailed information. | |
ResumeInformation | GetStackPartResumeInformation (const CFileItem &item, unsigned int partNumber) |
Get resume information for a part of a stack item. | |
|
strong |
ResumeInformation KODI::VIDEO::UTILS::GetItemResumeInformation | ( | const CFileItem & | item | ) |
Check whether playback of the given item can be resumed, get detailed information.
item | The item to retrieve information for |
bool KODI::VIDEO::UTILS::GetItemsForPlayList | ( | const std::shared_ptr< CFileItem > & | item, |
CFileItemList & | queuedItems ) |
For a given item, get the items to put in a playlist. If the item is a folder, all subitems will be added recursively to the returned item list. If the item is a playlist, the playlist will be loaded and contained items will be added to the returned item list. Shows a busy dialog if action takes certain amount of time to give the user visual feedback.
item | [in] the item to add to the playlist |
queuedItems | [out] the items that can be put in a play list |
std::string KODI::VIDEO::UTILS::GetOpticalMediaPath | ( | const CFileItem & | item | ) |
Check whether an item is an optical media folder or its parent. This will return the non-empty path to the playable entry point of the media one or two levels down (VIDEO_TS.IFO for DVDs or index.bdmv for BDs). The returned path will be empty if folder does not meet this criterion.
std::string KODI::VIDEO::UTILS::GetResumeString | ( | const CFileItem & | item | ) |
Get a localized resume string for the given item, if it is resumable.
item | The item to retrieve the resume string for |
ResumeInformation KODI::VIDEO::UTILS::GetStackPartResumeInformation | ( | const CFileItem & | item, |
unsigned int | partNumber ) |
Get resume information for a part of a stack item.
item | The stack item to retrieve information for |
partNumber | The number of the part |
Check whether for the given item information is stored in the video database.
item | The item to check |
Check whether auto play next item is set for the media type of the given item.
item | [in] the item to check |
bool KODI::VIDEO::UTILS::IsAutoPlayNextItem | ( | const std::string & | content | ) |
Check whether auto play next item is set for the given content type.
item | [in] the content to check |
Check whether the given item can be played by the app playlist player as one or more videos.
item | The item to check |
void KODI::VIDEO::UTILS::PlayItem | ( | const std::shared_ptr< CFileItem > & | item, |
const std::string & | player, | ||
ContentUtils::PlayMode | mode = ContentUtils::PlayMode::CHECK_AUTO_PLAY_NEXT_ITEM ) |
Start playback of the given item. If the item is a folder, build a playlist with all items contained in the folder and start playback of the playlist. If item is a single video item, start playback directly, without adding it to the video playlist first.
item | [in] the item to play |
player | [in] the player to use, empty for default player |
mode | [in] queue all successors and play them after item |
void KODI::VIDEO::UTILS::QueueItem | ( | const std::shared_ptr< CFileItem > & | item, |
QueuePosition | pos ) |
Queue the given item in the currently active playlist. If no playlist is active, put the item into the video playlist.
item | [in] the item to queue |
pos | [in] whether to place the item and the begin or the end of the queue |