| GStreamer Base Plugins 0.10 Library Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | ||||
#include <gst/rtsp/gstrtspdefs.h> #define GST_RTSP_CHECK (stmt, label) #define GST_RTSP_AUTH_MAX enum GstRTSPEvent; enum GstRTSPResult; enum GstRTSPFamily; enum GstRTSPState; enum GstRTSPVersion; enum GstRTSPMethod; enum GstRTSPAuthMethod; enum GstRTSPHeaderField; enum GstRTSPStatusCode; gchar * gst_rtsp_strresult (GstRTSPResult result); const gchar * gst_rtsp_method_as_text (GstRTSPMethod method); const gchar * gst_rtsp_version_as_text (GstRTSPVersion version); const gchar * gst_rtsp_header_as_text (GstRTSPHeaderField field); gboolean gst_rtsp_header_allow_multiple (GstRTSPHeaderField field); const gchar * gst_rtsp_status_as_text (GstRTSPStatusCode code); gchar * gst_rtsp_options_as_text (GstRTSPMethod options); GstRTSPHeaderField gst_rtsp_find_header_field (const gchar *header); GstRTSPMethod gst_rtsp_find_method (const gchar *method);
#define GST_RTSP_CHECK(stmt, label)
Macro that checks the return value of stmt and jumps to label when it does
not equal GST_RTSP_OK.
|
a statement |
|
a label |
#define GST_RTSP_AUTH_MAX GST_RTSP_AUTH_DIGEST
Strongest available authentication method
typedef enum {
GST_RTSP_EV_READ = (1 << 0),
GST_RTSP_EV_WRITE = (1 << 1)
} GstRTSPEvent;
The possible events for the connection.
typedef enum {
GST_RTSP_OK = 0,
/* errors */
GST_RTSP_ERROR = -1,
GST_RTSP_EINVAL = -2,
GST_RTSP_EINTR = -3,
GST_RTSP_ENOMEM = -4,
GST_RTSP_ERESOLV = -5,
GST_RTSP_ENOTIMPL = -6,
GST_RTSP_ESYS = -7,
GST_RTSP_EPARSE = -8,
GST_RTSP_EWSASTART = -9,
GST_RTSP_EWSAVERSION = -10,
GST_RTSP_EEOF = -11,
GST_RTSP_ENET = -12,
GST_RTSP_ENOTIP = -13,
GST_RTSP_ETIMEOUT = -14,
GST_RTSP_ETGET = -15,
GST_RTSP_ETPOST = -16,
GST_RTSP_ELAST = -17
} GstRTSPResult;
Result codes from the RTSP functions.
| no error | |
| some unspecified error occured | |
| invalid arguments were provided to a function | |
| an operation was canceled | |
| no memory was available for the operation | |
| a host resolve error occured | |
| function not implemented | |
| a system error occured, errno contains more details | |
| a persing error occured | |
| windows networking could not start | |
| windows networking stack has wrong version | |
| end-of-file was reached | |
| a network problem occured, h_errno contains more details | |
| the host is not an IP host | |
| a timeout occured | |
| the tunnel GET request has been performed | |
| the tunnel POST request has been performed | |
| last error |
typedef enum {
GST_RTSP_FAM_NONE,
GST_RTSP_FAM_INET,
GST_RTSP_FAM_INET6
} GstRTSPFamily;
The possible network families.
typedef enum {
GST_RTSP_STATE_INVALID,
GST_RTSP_STATE_INIT,
GST_RTSP_STATE_READY,
GST_RTSP_STATE_SEEKING,
GST_RTSP_STATE_PLAYING,
GST_RTSP_STATE_RECORDING
} GstRTSPState;
The different RTSP states.
typedef enum {
GST_RTSP_VERSION_INVALID = 0x00,
GST_RTSP_VERSION_1_0 = 0x10,
GST_RTSP_VERSION_1_1 = 0x11
} GstRTSPVersion;
The supported RTSP versions.
typedef enum {
GST_RTSP_INVALID = 0,
GST_RTSP_DESCRIBE = (1 << 0),
GST_RTSP_ANNOUNCE = (1 << 1),
GST_RTSP_GET_PARAMETER = (1 << 2),
GST_RTSP_OPTIONS = (1 << 3),
GST_RTSP_PAUSE = (1 << 4),
GST_RTSP_PLAY = (1 << 5),
GST_RTSP_RECORD = (1 << 6),
GST_RTSP_REDIRECT = (1 << 7),
GST_RTSP_SETUP = (1 << 8),
GST_RTSP_SET_PARAMETER = (1 << 9),
GST_RTSP_TEARDOWN = (1 << 10),
GST_RTSP_GET = (1 << 11),
GST_RTSP_POST = (1 << 12)
} GstRTSPMethod;
The different supported RTSP methods.
| invalid method | |
| the DESCRIBE method | |
| the ANNOUNCE method | |
| the GET_PARAMETER method | |
| the OPTIONS method | |
| the PAUSE method | |
| the PLAY method | |
| the RECORD method | |
| the REDIRECT method | |
| the SETUP method | |
| the SET_PARAMETER method | |
| the TEARDOWN method | |
| the GET method (HTTP). Since 0.10.25 | |
| the POST method (HTTP). Since 0.10.25 |
typedef enum {
GST_RTSP_AUTH_NONE = 0x00,
GST_RTSP_AUTH_BASIC = 0x01,
GST_RTSP_AUTH_DIGEST = 0x02
} GstRTSPAuthMethod;
Authentication methods, ordered by strength
gchar * gst_rtsp_strresult (GstRTSPResult result);
Convert result in a human readable string.
|
a GstRTSPResult |
Returns : |
a newly allocated string. g_free() after usage. |
const gchar * gst_rtsp_method_as_text (GstRTSPMethod method);
Convert method to a string.
|
a GstRTSPMethod |
Returns : |
a string representation of method. |
const gchar * gst_rtsp_version_as_text (GstRTSPVersion version);
Convert version to a string.
|
a GstRTSPVersion |
Returns : |
a string representation of version. |
const gchar * gst_rtsp_header_as_text (GstRTSPHeaderField field);
Convert field to a string.
|
a GstRTSPHeaderField |
Returns : |
a string representation of field. |
gboolean gst_rtsp_header_allow_multiple (GstRTSPHeaderField field);
Check whether field may appear multiple times in a message.
|
a GstRTSPHeaderField |
Returns : |
TRUE if multiple headers are allowed. |
Since 0.10.25
const gchar * gst_rtsp_status_as_text (GstRTSPStatusCode code);
Convert code to a string.
|
a GstRTSPStatusCode |
Returns : |
a string representation of code. |
gchar * gst_rtsp_options_as_text (GstRTSPMethod options);
Convert options to a string.
|
one or more GstRTSPMethod |
Returns : |
a new string of options. g_free() after usage. |
Since 0.10.23
GstRTSPHeaderField gst_rtsp_find_header_field (const gchar *header);
Convert header to a GstRTSPHeaderField.
|
a header string |
Returns : |
a GstRTSPHeaderField for header or GST_RTSP_HDR_INVALID if the
header field is unknown. |
GstRTSPMethod gst_rtsp_find_method (const gchar *method);
Convert method to a GstRTSPMethod.
|
a method |
Returns : |
a GstRTSPMethod for method or GST_RTSP_INVALID if the
method is unknown. |