avtransport_event.h

来自「AMLOGIC DPF source code」· C头文件 代码 · 共 395 行

/*******************************************************************
 * 
 *  Copyright C 2005 by Amlogic, Inc. All Rights Reserved.
 *
 *  Description: 
 *
 *  Author: Eric Knudstrup
 *  Created: Wed Nov  9 16:26:10 2005
 *
 *******************************************************************/

#ifndef AVTRANSPORT_EVENT_H
#define AVTRANSPORT_EVENT_H

typedef enum {
    AVT_TRANSPORT_PLAYING = 0, 
    AVT_TRANSPORT_STOPPED,
    AVT_TRANSPORT_TRANSITIONING,
    AVT_TRANSPORT_PAUSED_PLAYBACK,
    AVT_TRANSPORT_NO_MEDIA
} AVTransportState_t;

typedef enum {
    AVT_STATUS_OK = 0,
    AVT_STATUS_ERROR
} AVTransportStatus_t;

#define AVT_STR_BUF_SIZE 512

/*;emacs generated header for file AVTransport_event.c. Global function declarations only. */
/**
 * Register the AVTransport service's event variables.
 */
extern void
UPnP_AVT_event_init(void);

/**
 * Get the AVTransport AbsoluteCounterPosition variable.
 * @returns The current \a AbsoluteCounterPosition.
 */
extern uint32_t
UPnP_AVT_get_AbsoluteCounterPosition(void);

/**
 * Get the AVTransport RelativeCounterPosition variable.
 * @returns The current \a RelativeCounterPosition.
 */
extern uint32_t
UPnP_AVT_get_RelativeCounterPosition(void);

/**
 * Get the string value of the AVTransport AbsoluteTimePosition variable.
 * @param[in] buffer Buffer to copy the AbsoluteTimePosition into.
 * @param[in] len Length of the \a buffer.
 * @returns A pointer to the \a buffer.
 */
extern char *
UPnP_AVT_get_AbsoluteTimePosition_str(char *buffer, int len);

/**
 * Get the AVTransport AbsoluteTimePosition variable.
 * @returns The current \a AbsoluteTimePosition.
 */
extern uint32_t
UPnP_AVT_get_AbsoluteTimePosition(void);

/**
 * Get the string value of the AVTransport RelativeTimePosition variable.
 * @param[in] buffer Buffer to copy the RelativeTimePosition into.
 * @param[in] len Length of the \a buffer.
 * @returns A pointer to the \a buffer.
 */
extern char *
UPnP_AVT_get_RelativeTimePosition_str(char *buffer, int len);

/**
 * Get the AVTransport RelativeTimePosition variable.
 * @returns The current \a RelativeTimePosition.
 */
extern uint32_t
UPnP_AVT_get_RelativeTimePosition(void);

/**
 * Get the AVTransport NextAVTransportURIMetaData variable.
 * @returns The current \a NextAVTransportURIMetaData.
 */
extern char *
UPnP_AVT_get_NextAVTransportURIMetaData(char *buffer, int len);

/**
 * Get the AVTransport NextAVTransportURI variable.
 * @param[in] buffer Buffer to copy the NextAVTransportURI into.
 * @param[in] len Length of the \a buffer.
 * @returns A pointer to the \a buffer.
 */
extern char *
UPnP_AVT_get_NextAVTransportURI(char *buffer, int len);

/**
 * Get the AVTransport AVTransportURIMetaData variable.
 * @param[in] buffer Buffer to copy the AVTransportURIMetaData into.
 * @param[in] len Length of the \a buffer.
 * @returns A pointer to the \a buffer.
 */
extern char *
UPnP_AVT_get_AVTransportURIMetaData(char *buffer, int len);

/**
 * Get the AVTransport AVTransportURI variable.
 * @param[in] buffer Buffer to copy the AVTransportURI into.
 * @param[in] len Length of the \a buffer.
 * @returns A pointer to the \a buffer.
 */
extern char *
UPnP_AVT_get_AVTransportURI(char *buffer, int len);

/**
 * Get the AVTransport CurrentTrackURI variable.
 * @param[in] buffer Buffer to copy the CurrentTrackMetaData into.
 * @param[in] len Length of the \a buffer.
 * @returns A pointer to the \a buffer.
 */
extern char *
UPnP_AVT_get_CurrentTrackURI(char *buffer, int len);

/**
 * Get the AVTransport CurrentTrackMetaData variable.
 * @param[in] buffer Buffer to copy the CurrentTrackMetaData into.
 * @param[in] len Length of the \a buffer.
 * @returns A pointer to the \a buffer.
 */
extern char *
UPnP_AVT_get_CurrentTrackMetaData(char *buffer, int len);

/**
 * Get the string value of the AVTransport CurrentMediaDuration variable.
 * @param[in] buffer A buffer to put the CurrentMediaDuration
 * variable into.
 * @param[in] len Length of the \a buffer.
 * @returns The current \a CurrentMediaDuration.
 */
extern char *
UPnP_AVT_get_CurrentMediaDuration_str(char *buffer, int len);

/**
 * Get the string value of the AVTransport CurrentMediaDuration variable.
 * @param[in] buffer A buffer to put the CurrentMediaDuration
 * variable into.
 * @param[in] len Length of the \a buffer.
 * @returns The current \a CurrentMediaDuration.
 */
extern uint32_t
UPnP_AVT_get_CurrentMediaDuration(void);

/**
 * Get the string value of the AVTransport CurrentTrackDuration variable.
 * @param[in] buffer A buffer to put the CurrentTrackDuration
 * variable into.
 * @param[in] len Length of the \a buffer.
 * @returns The current \a CurrentTrack.
 */
extern char *
UPnP_AVT_get_CurrentTrackDuration_str(char *buffer, int len);

/**
 * Get the value of the AVTransport CurrentTrackDuration variable.
 * @param[in] buffer A buffer to put the CurrentTrackDuration
 * variable into.
 * @param[in] len Length of the \a buffer.
 * @returns The current \a CurrentTrack.
 */
extern uint32_t
UPnP_AVT_get_CurrentTrackDuration(void);

/**
 * Get the AVTransport CurrentTrack variable.
 * @returns The current \a CurrentTrack.
 */
extern uint32_t
UPnP_AVT_get_CurrentTrack(void);

/**
 * Get the AVTransport NumberOfTracks variable.
 * @returns The current \a NumberOfTracks.
 */
extern uint32_t
UPnP_AVT_get_NumberOfTracks(void);

/**
 * Copy the current value of the PossibleRecordQualityModes int \a buffer,
 * bounded by length \a len.
 * @returns A pointer to \a buffer.
 */
extern char *
UPnP_AVT_get_PossibleRecordQualityModes(char *buffer, int len);

/**
 * Copy the current value of the CurrentRecordQualityMode int \a buffer,
 * bounded by length \a len.
 * @returns A pointer to \a buffer.
 */
extern char *
UPnP_AVT_get_CurrentRecordQualityMode(char *buffer, int len);

/**
 * Copy the current value of the RecordMediumWriteStatus int \a buffer,
 * bounded by length \a len.
 * @returns A pointer to \a buffer.
 */
extern char *
UPnP_AVT_get_RecordMediumWriteStatus(char *buffer, int len);

/**
 * Copy the current value of the TransportPlaySpeed int \a buffer,
 * bounded by length \a len.
 * @returns A pointer to \a buffer.
 */
extern char *
UPnP_AVT_get_TransportPlaySpeed(char *buffer, int len);

/**
 * Copy the current value of the CurrentPlayMode int \a buffer,
 * bounded by length \a len.
 * @returns A pointer to \a buffer.
 */
extern char *
UPnP_AVT_get_CurrentPlayMode(char *buffer, int len);

/**
 * Copy the current value of the PossibleRecordStorageMedia int \a buffer,
 * bounded by length \a len.
 * @returns A pointer to \a buffer.
 */
extern char *
UPnP_AVT_get_PossibleRecordStorageMedia(char *buffer, int len);

/**
 * Copy the current value of the PossiblePlaybackStorageMedia int \a buffer,
 * bounded by length \a len.
 * @returns A pointer to \a buffer.
 */
extern char *
UPnP_AVT_get_PossiblePlaybackStorageMedia(char *buffer, int len);

/**
 * Copy the current value of the RecordStorageMedium int \a buffer,
 * bounded by length \a len.
 * @returns A pointer to \a buffer.
 */
extern char *
UPnP_AVT_get_RecordStorageMedium(char *buffer, int len);

/**
 * Copy the current value of the PlaybackStorageMedium int \a buffer,
 * bounded by length \a len.
 * @returns A pointer to \a buffer.
 */
extern char *
UPnP_AVT_get_PlaybackStorageMedium(char *buffer, int len);

/**
 * Return the current TransportStatus as a string.
 */
extern char *
UPnP_AVT_get_TransportStatus_str(char *buffer, int len);

/**
 * Get the AVTransport TransportState variable.
 * @returns The current \a AVTransportState_t.
 */
extern AVTransportState_t
UPnP_AVT_get_TransportStatus(void);

/**
 * Given a string of a new TransportState, check it against the possible 
 * state strings.
 * @returns 0 if a TransportState was matched, otherwise non-zero.
 */
extern char *
UPnP_AVT_get_TransportState_str(char *buffer, int len);

/**
 * Get the AVTransport TransportState variable.
 * @returns The current \a AVTransportState_t.
 */
extern AVTransportState_t
UPnP_AVT_get_TransportState(void);

/**
 * Set the AVTransport AbsoluteCounterPosition variable.
 * Not evented with LastChange.
 */
extern void
UPnP_AVT_set_AbsoluteCounterPosition(uint32_t abs_ctr_pos);

/**
 * Set the AVTransport RelativeCounterPosition variable.
 * Not evented with LastChange.
 */
extern void
UPnP_AVT_set_RelativeCounterPosition(uint32_t rel_ctr_pos);

/**
 * Set the AVTransport AbsoluteTimePosition variable.
 * Not evented with LastChange.
 */
extern void
UPnP_AVT_set_AbsoluteTimePosition(uint32_t abs_time_pos);

/**
 * Set the AVTransport RelativeTimePosition variable.
 * Not evented with LastChange.
 */
extern void
UPnP_AVT_set_RelativeTimePosition(uint32_t rel_time_pos);

/**
 * Set the AVTransport NextAVTransportURIMetaData variable.
 */
extern void
UPnP_AVT_set_NextAVTransportURIMetaData(char *uri);

/**
 * Set the AVTransport NextAVTransportURI variable.
 */
extern void
UPnP_AVT_set_NextAVTransportURI(char *uri);

/**
 * Set the AVTransport AVTransportURIMetaData variable.
 */
extern void
UPnP_AVT_set_AVTransportURIMetaData(char *meta_data);

/**
 * Set the AVTransport AVTransportURI variable.
 */
extern void
UPnP_AVT_set_AVTransportURI(char *uri);

/**
 * Set the AVTransport CurrentTrackURI variable.
 */
extern void
UPnP_AVT_set_CurrentTrackURI(char *uri);

/**
 * Set the AVTransport CurrentTrackMetaData variable.
 */
extern void
UPnP_AVT_set_CurrentTrackMetaData(char *meta_data);

/**
 * Set the AVTransport CurrentMediaDuration variable.
 */
extern void
UPnP_AVT_set_CurrentMediaDuration(uint32_t dur_secs);

/**
 * Set the AVTransport CurrentTrackDuration variable.
 */
extern void
UPnP_AVT_set_CurrentTrackDuration(uint32_t dur_secs);

/**
 * Set the AVTransport CurrentTrack variable.
 */
extern void
UPnP_AVT_set_CurrentTrack(int current_track);

/**
 * Set the AVTransport NumberOfTracks variable.
 */
extern void
UPnP_AVT_set_NumberOfTracks(int ntracks);

/**
 * Set the AVTransport TransportStatus variable.
 * @param [in] new_state The new \a AVTransportStatus_t.
 */
extern void
UPnP_AVT_set_TransportStatus(AVTransportStatus_t new_status);

/**
 * Set the AVTransport TransportState variable.
 * @param [in] new_state The new \a AVTransportState_t.
 */
extern void
UPnP_AVT_set_TransportState(AVTransportState_t new_state);


/*;end emacs generated header for file AVTransport_event.c. Global function declarations only. */

#endif