cavtcontrolpoint.h File Reference

#include <cybergarage/avtransport/cavtransport.h>
#include <cybergarage/avtransport/cavtactionarguments.h>
#include <cybergarage/upnp/cdevice.h>

Go to the source code of this file.

Defines
#define	cg_upnp_av_avt_control_setavtransporturi(upnpDevice, errorString, instanceID, uri, uriMetaData)
#define	cg_upnp_av_avt_control_setnextavtransporturi(upnpDevice, errorString, instanceID, nextUri, nextUriMetaData)
#define	cg_upnp_av_avt_control_getmediainfo(upnpDevice, errorString, instanceID, nrTracks, mediaDuration, currentUri, currentUriMetaData, nextUri, nextUriMetaData, playMedium, recordMedium, writeStatus)
#define	cg_upnp_av_avt_control_gettransportinfo(upnpDevice, errorString, instanceID, currentTransportState, currentTransportStatus, currentSpeed)
#define	cg_upnp_av_avt_control_getpositioninfo(upnpDevice, errorString, instanceID, track, trackDuration, trackMetaData, trackURI, relTime, absTime, relCount, absCount)
#define	cg_upnp_av_avt_control_getdevicecapabilities(upnpDevice, errorString, instanceID, playMedia, recMedia, recQualityModes)
#define	cg_upnp_av_avt_control_gettransportsettings(upnpDevice, errorString, instanceID, playMode, recQualityMode)
#define	cg_upnp_av_avt_control_stop(upnpDevice, errorString, instanceID)
#define	cg_upnp_av_avt_control_play(upnpDevice, errorString, instanceID, speed)
#define	cg_upnp_av_avt_control_pause(upnpDevice, errorString, instanceID)
#define	cg_upnp_av_avt_control_record(upnpDevice, errorString, instanceID)
#define	cg_upnp_av_avt_control_seek(upnpDevice, errorString, instanceID, unit, target)
#define	cg_upnp_av_avt_control_next(upnpDevice, errorString, instanceID)
#define	cg_upnp_av_avt_control_previous(upnpDevice, errorString, instanceID)
#define	cg_upnp_av_avt_control_setplaymode(upnpDevice, errorString, instanceID, newPlayMode)
#define	cg_upnp_av_avt_control_setrecordqualitymode(upnpDevice, errorString, instanceID, newRecordQualityMode)
#define	cg_upnp_av_avt_control_getcurrenttransportactions(upnpDevice, errorString, instanceID, actions)
Functions
int	cg_upnp_av_avt_control_invokeaction (CgUpnpDevice *upnpDevice, char *actionName, char **errorString,...)

---

Define Documentation

#define cg_upnp_av_avt_control_getcurrenttransportactions (  upnpDevice, errorString, instanceID, actions   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_GET_CURRENTTRANSPORTACTIONS, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ CG_UPNP_AVT_ARG_ACTIONS, \ actions, \ NULL) Invoke an action on the upnp device to get the current transport actions on the given given AVT instance Note: Optional action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN) actions  Currently active transport actions (OUT)

#define cg_upnp_av_avt_control_getdevicecapabilities (  upnpDevice, errorString, instanceID, playMedia, recMedia, recQualityModes   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_GET_DEVICECAPABILITIES, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ CG_UPNP_AVT_ARG_PLAYMEDIA, \ playMedia, \ CG_UPNP_AVT_ARG_RECMEDIA, \ recMedia, \ CG_UPNP_AVT_ARG_RECQUALITYMODES, \ recQualityModes, \ NULL) Invoke an action on the upnp device to get device capabilities from the given AVT instance Note: Mandatory action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id

#define cg_upnp_av_avt_control_getmediainfo (  upnpDevice, errorString, instanceID, nrTracks, mediaDuration, currentUri, currentUriMetaData, nextUri, nextUriMetaData, playMedium, recordMedium, writeStatus   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_GET_MEDIAINFO, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ CG_UPNP_AVT_ARG_NRTRACKS, \ nrTracks, \ CG_UPNP_AVT_ARG_MEDIADURATION, \ mediaDuration, \ CG_UPNP_AVT_ARG_CURRENTURI, \ currentUri, \ CG_UPNP_AVT_ARG_CURRENTURIMETADATA, \ currentUriMetaData, \ CG_UPNP_AVT_ARG_NEXTURI, \ nextUri, \ CG_UPNP_AVT_ARG_NEXTURIMETADATA, \ nextUriMetaData, \ CG_UPNP_AVT_ARG_PLAYMEDIUM, \ playMedium, \ CG_UPNP_AVT_ARG_RECORDMEDIUM, \ recordMedium, \ CG_UPNP_AVT_ARG_WRITESTATUS, \ writeStatus, \ NULL) Invoke an action on the upnp device to get media info from the given AVT instance Note: Mandatory action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN) nrTracks  Number of tracks (OUT) mediaDuration  Current media duration (OUT) instanceID  The AV transport instance id uri  The AV Transport URI (OUT) uriMetaData  Meta data for current URI (OUT) nextUri  The next transport URI (OUT) nextUriMetaData  Meta data for next URI (OUT) playMedium  Current playing medium (OUT) recordMedium  Current recording medium (OUT) writeStatus  Current writing status (OUT)

#define cg_upnp_av_avt_control_getpositioninfo (  upnpDevice, errorString, instanceID, track, trackDuration, trackMetaData, trackURI, relTime, absTime, relCount, absCount   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_GET_POSITIONINFO, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ CG_UPNP_AVT_ARG_TRACK, \ track, \ CG_UPNP_AVT_ARG_TRACKDURATION, \ trackDuration, \ CG_UPNP_AVT_ARG_TRACKMETADATA, \ trackMetaData, \ CG_UPNP_AVT_ARG_TRACKURI, \ trackURI, \ CG_UPNP_AVT_ARG_RELTIME, \ relTime, \ CG_UPNP_AVT_ARG_ABSTIME, \ absTime, \ CG_UPNP_AVT_ARG_RELCOUNT, \ relCount, \ CG_UPNP_AVT_ARG_ABSCOUNT, \ absCount, \ NULL) Invoke an action on the upnp device to get position info from the given AVT instance Note: Mandatory action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN) track  Current track number (OUT) trackDuration  Current track duration (OUT) trackMetaData  Current track meta data (OUT) trackURI  Current track URI (OUT) relTime  Current track relative time (OUT) absTime  Current track absolute time (OUT) relCount  Current track relative count (OUT) absCount  Current track absolute count (OUT)

#define cg_upnp_av_avt_control_gettransportinfo (  upnpDevice, errorString, instanceID, currentTransportState, currentTransportStatus, currentSpeed   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_GET_TRANSPORTINFO, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ CG_UPNP_AVT_ARG_CURRENTTRANSPORTSTATE, \ currentTransportState, \ CG_UPNP_AVT_ARG_CURRENTTRANSPORTSTATUS, \ currentTransportStatus, \ CG_UPNP_AVT_ARG_CURRENTSPEED, \ currentSpeed, \ NULL) Invoke an action on the upnp device to get transport info from the given AVT instance Note: Mandatory action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN) currentTransportState  Current Transport State (OUT) currentTransportStatus  Current Transport Status (OUT) currentSpeed  Current Speed (OUT)

#define cg_upnp_av_avt_control_gettransportsettings (  upnpDevice, errorString, instanceID, playMode, recQualityMode   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_GET_TRANSPORTSETTINGS, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ CG_UPNP_AVT_ARG_PLAYMODE, \ playMode, \ CG_UPNP_AVT_ARG_RECQUALITYMODE, \ recQualityMode, \ NULL) Invoke an action on the upnp device to get transport settings from the given AVT instance Note: Mandatory action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN) playMode  Current playing mode (OUT) recQualityMode  Current recording quality mode (OUT)

#define cg_upnp_av_avt_control_next (  upnpDevice, errorString, instanceID   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_NEXT, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ NULL) Invoke an action on the upnp device to skip the current media on the given AVT instance to the next media in the playlist. Note: Mandatory action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN)

#define cg_upnp_av_avt_control_pause (  upnpDevice, errorString, instanceID   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_PAUSE, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ NULL) Invoke an action on the upnp device to pause playing the current media on the given AVT instance Note: Optional action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN)

#define cg_upnp_av_avt_control_play (  upnpDevice, errorString, instanceID, speed   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_PLAY, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ CG_UPNP_AVT_ARG_SPEED, \ speed, \ NULL) Invoke an action on the upnp device to start playing the current media on the given AVT instance Note: Mandatory action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN) speed  Playing speed (OUT)

#define cg_upnp_av_avt_control_previous (  upnpDevice, errorString, instanceID   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_PREVIOUS, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ NULL) Invoke an action on the upnp device to skip the current media on the given AVT instance to the previous media in the playlist. Note: Mandatory action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN)

#define cg_upnp_av_avt_control_record (  upnpDevice, errorString, instanceID   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_RECORD, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ NULL) Invoke an action on the upnp device to start recording on the given AVT instance Note: Optional action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN)

#define cg_upnp_av_avt_control_seek (  upnpDevice, errorString, instanceID, unit, target   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_SEEK, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ CG_UPNP_AVT_ARG_UNIT, \ unit, \ CG_UPNP_AVT_ARG_TARGET, \ target, \ NULL) Invoke an action on the upnp device to seek the current media on the given AVT instance to a given position Note: Mandatory action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN) unit  Seek mode (OUT) target  The seek target (OUT)

#define cg_upnp_av_avt_control_setavtransporturi (  upnpDevice, errorString, instanceID, uri, uriMetaData   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_SET_AVTRANSPORTURI, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, instanceID, \ CG_UPNP_AVT_ARG_CURRENTURI, uri, \ CG_UPNP_AVT_ARG_CURRENTURIMETADATA, uriMetaData, \ NULL) Invoke an action on the upnp device to set the AV transport URI for the given AVT instance Note: Mandatory action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN) uri  The AV Transport URI (IN) uriMetaData  Optional meta data (IN)

#define cg_upnp_av_avt_control_setnextavtransporturi (  upnpDevice, errorString, instanceID, nextUri, nextUriMetaData   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_SET_NEXTAVTRANSPORTURI, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, instanceID, \ CG_UPNP_AVT_ARG_NEXTURI, nextUri, \ CG_UPNP_AVT_ARG_NEXTURIMETADATA, nextUriMetaData, \ NULL) Invoke an action on the upnp device to set the next AV transport URI for the given AVT instance Note: Optional action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN) nextUri  The next transport URI (IN) nextUriMetaData  Optional meta data for next URI (IN)

#define cg_upnp_av_avt_control_setplaymode (  upnpDevice, errorString, instanceID, newPlayMode   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_SET_PLAYMODE, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ CG_UPNP_AVT_ARG_NEWPLAYMODE, \ newPlayMode, \ NULL) Invoke an action on the upnp device to set the play mode for the current media on the given AVT instance Note: Optional action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN) newPlayMode  The new play mode (IN)

#define cg_upnp_av_avt_control_setrecordqualitymode (  upnpDevice, errorString, instanceID, newRecordQualityMode   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_SET_RECORDQUALITYMODE, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ CG_UPNP_AVT_ARG_NEWRECORDQUALITYMODE, \ newRecordQualityMode, \ NULL) Invoke an action on the upnp device to set the record mode on the given AVT instance Note: Optional action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN) newRecordQualityMode  The new record quality mode (IN)

#define cg_upnp_av_avt_control_stop (  upnpDevice, errorString, instanceID   )

Value: \ cg_upnp_av_avt_control_invokeaction(upnpDevice, \ CG_UPNP_AVT_ACTION_STOP, \ errorString, \ CG_UPNP_AVT_ARG_INSTANCEID, \ instanceID, \ NULL) Invoke an action on the upnp device to stop the current media on the given AVT instance Note: Mandatory action Parameters: upnpDevice  The UPnP device instanceID  The AV transport instance id (IN)

---

Function Documentation

int cg_upnp_av_avt_control_invokeaction (  CgUpnpDevice *  upnpDevice, char *  actionName, char **  errorString,   ... )

Invoke an action on the upnp device Parameters: upnpDevice  The UPnP device actionName  The name of the action to invoke errorString  A newly-created error string if the action fails. Pass NULL if you don't want to use it. ...  A list of action-specific arguments Returns: An integer containing the UPnP status code The list of action-specific arguments is a comma-separated list, that is organised as pairs of char* ARG_NAME and CgString* ARG_VALUE. ARG_NAME contains the name of the argument, while ARG_VALUE contains the value of the argument. You don't need to put anything inside OUT arguments, as they are not sent along with the action; their contents are set when the action post returns with OUT values that were received from the peer.

---