Commit 7b7f2fe0 authored by Olivier Aubert's avatar Olivier Aubert

mediacontrol: doxygen updates

parent 53af6645
This diff is collapsed.
...@@ -20,6 +20,12 @@ ...@@ -20,6 +20,12 @@
* along with this program; if not, write to the Free Software * along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/ *****************************************************************************/
/**
* \defgroup mediacontrol_structures MediaControl Structures
* Data structures used in the MediaControl API.
*
* @{
*/
#ifndef _VLC_CONTROL_STRUCTURES_H #ifndef _VLC_CONTROL_STRUCTURES_H
#define _VLC_CONTROL_STRUCTURES_H 1 #define _VLC_CONTROL_STRUCTURES_H 1
...@@ -28,18 +34,33 @@ ...@@ -28,18 +34,33 @@
extern "C" { extern "C" {
# endif # endif
/**
* A position may have different origins:
* - absolute counts from the movie start
* - relative counts from the current position
* - modulo counts from the current position and wraps at the end of the movie
*/
typedef enum { typedef enum {
mediacontrol_AbsolutePosition, mediacontrol_AbsolutePosition,
mediacontrol_RelativePosition, mediacontrol_RelativePosition,
mediacontrol_ModuloPosition mediacontrol_ModuloPosition
} mediacontrol_PositionOrigin; } mediacontrol_PositionOrigin;
/**
* Units available in mediacontrol Positions
* - ByteCount number of bytes
* - SampleCount number of frames
* - MediaTime time in milliseconds
*/
typedef enum { typedef enum {
mediacontrol_ByteCount, mediacontrol_ByteCount,
mediacontrol_SampleCount, mediacontrol_SampleCount,
mediacontrol_MediaTime mediacontrol_MediaTime
} mediacontrol_PositionKey; } mediacontrol_PositionKey;
/**
* MediaControl Position
*/
typedef struct { typedef struct {
mediacontrol_PositionOrigin origin; mediacontrol_PositionOrigin origin;
mediacontrol_PositionKey key; mediacontrol_PositionKey key;
...@@ -51,3 +72,5 @@ typedef struct { ...@@ -51,3 +72,5 @@ typedef struct {
# endif # endif
#endif #endif
/** @} */
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment