mme_playlist_open()

Open a playlist

Synopsis:

#include <mme/playlist.h>

mme_playlist_hdl_t mme_playlist_open( mme_hdl_t *hdl,
                                      uint64_t plid,
                                      uint32_t flags );

Arguments:

hdl
An MME connection handle.
folderid
The ID of the playlist to open.
flags
For future use.

Library:

mme

Description:

The function mme_playlist_open() returns a handle to be used to work with a playlist. After calling mme_playlist_open(), you can use other mme_playlist_*() functions to find and extract entries from the opened playlist.


Note: This function can only open a playlist if a playlist synchronization (PLSS) plugin able to process the playlist is available. If no PLSS plugin for the playlist is available, mme_playlist_open() fails.

Events

None delivered.

Blocking and validation

This function validates the playlist ID, and runs to completion.

Returns:

An initialized mme_playlist_hdl_t, or NULL if an error occurred (errno is set).

Classification:

QNX Neutrino

Safety:
Interrupt handler No
Signal handler No
Thread Yes

See also:

MME_PLAYLIST_*, mme_playlist_close(), mme_playlist_create(), mme_playlist_delete(), mme_playlist_generate_similar(), mme_playlist_hdl_t, mme_playlist_item_get(), mme_playlist_items_count_get(), mme_playlist_position_set(), mme_playlist_set_statement(), mme_playlist_sync()