gstsdp.sdpmessage

Module for [SDPMessage] class

class SDPMessage

Types 1

classSDPMessage : gobject.boxed.Boxed

The GstSDPMessage helper functions makes it easy to parse and create SDP messages.

Methods
void * _cPtr(Flag!"Dup" dup = No.Dup) nothrow
GType _getGType() static nothrow
GType _gType() @property nothrow
SDPMessage self() nothrowReturns `this`, for use in `with` statements.
string version_() @property nothrowGet `version_` field. Returns: the protocol version
void version_(string propval) @property nothrowSet `version_` field. Params: propval = the protocol version
gstsdp.sdporigin.SDPOrigin origin() @property nothrowGet `origin` field. Returns: owner/creator and session identifier
string sessionName() @property nothrowGet `sessionName` field. Returns: session name
void sessionName(string propval) @property nothrowSet `sessionName` field. Params: propval = session name
string information() @property nothrowGet `information` field. Returns: session information
void information(string propval) @property nothrowSet `information` field. Params: propval = session information
string uri() @property nothrowGet `uri` field. Returns: URI of description
void uri(string propval) @property nothrowSet `uri` field. Params: propval = URI of description
gstsdp.sdpconnection.SDPConnection connection() @property nothrowGet `connection` field. Returns: connection information for the session
gstsdp.sdpkey.SDPKey key() @property nothrowGet `key` field. Returns: encryption key
gstsdp.types.SDPResult addAttribute(string key, string value = null) nothrowAdd the attribute with key and value to msg.
gstsdp.types.SDPResult addBandwidth(string bwtype, uint bandwidth) nothrowAdd the specified bandwidth information to msg.
gstsdp.types.SDPResult addEmail(string email) nothrowAdd email to the list of emails in msg.
gstsdp.types.SDPResult addMedia(gstsdp.sdpmedia.SDPMedia media) nothrowAdds media to the array of medias in msg. This function takes ownership of the contents of media so that media will have to be reinitialized with [gstsdp.sdpmedia.SDPMedia.init_] before it can be u...
gstsdp.types.SDPResult addPhone(string phone) nothrowAdd phone to the list of phones in msg.
gstsdp.types.SDPResult addTime(string start, string stop, string[] repeat) nothrowAdd time information start and stop to msg.
gstsdp.types.SDPResult addZone(string adjTime, string typedTime) nothrowAdd time zone information to msg.
string asText() nothrowConvert the contents of msg to a text string. Returns: A dynamically allocated string representing the SDP description.
uint attributesLen() nothrowGet the number of attributes in msg. Returns: the number of attributes in msg.
gstsdp.types.SDPResult attributesToCaps(gst.caps.Caps caps) nothrowMapping of attributes of #GstSDPMessage to #GstCaps
uint bandwidthsLen() nothrowGet the number of bandwidth information in msg. Returns: the number of bandwidth information in msg.
gstsdp.types.SDPResult copy(out gstsdp.sdpmessage.SDPMessage copy) nothrowAllocate a new copy of msg and store the result in copy. The value in copy should be release with gst_sdp_message_free function.
gstsdp.types.SDPResult dump() nothrowDump the parsed contents of msg to stdout. Returns: a #GstSDPResult.
uint emailsLen() nothrowGet the number of emails in msg. Returns: the number of emails in msg.
gstsdp.sdpattribute.SDPAttribute getAttribute(uint idx) nothrowGet the attribute at position idx in msg.
string getAttributeVal(string key) nothrowGet the first attribute with key key in msg.
string getAttributeValN(string key, uint nth) nothrowGet the nth attribute with key key in msg.
gstsdp.sdpbandwidth.SDPBandwidth getBandwidth(uint idx) nothrowGet the bandwidth at index idx from msg.
gstsdp.sdpconnection.SDPConnection getConnection() nothrowGet the connection of msg. Returns: a #GstSDPConnection. The result remains valid as long as msg is valid.
string getEmail(uint idx) nothrowGet the email with number idx from msg.
string getInformation() nothrowGet the information in msg. Returns: a #GstSDPResult.
gstsdp.sdpkey.SDPKey getKey() nothrowGet the encryption information from msg. Returns: a #GstSDPKey.
gstsdp.sdpmedia.SDPMedia getMedia(uint idx) nothrowGet the media description at index idx in msg.
gstsdp.sdporigin.SDPOrigin getOrigin() nothrowGet the origin of msg. Returns: a #GstSDPOrigin. The result remains valid as long as msg is valid.
string getPhone(uint idx) nothrowGet the phone with number idx from msg.
string getSessionName() nothrowGet the session name in msg. Returns: a #GstSDPResult.
gstsdp.sdptime.SDPTime getTime(uint idx) nothrowGet time information with index idx from msg.
string getUri() nothrowGet the URI in msg. Returns: a #GstSDPResult.
string getVersion() nothrowGet the version in msg. Returns: a #GstSDPResult.
gstsdp.sdpzone.SDPZone getZone(uint idx) nothrowGet time zone information with index idx from msg.
gstsdp.types.SDPResult insertAttribute(int idx, gstsdp.sdpattribute.SDPAttribute attr) nothrowInsert attribute into the array of attributes in msg at index idx. When -1 is given as idx, the attribute is inserted at the end.
gstsdp.types.SDPResult insertBandwidth(int idx, gstsdp.sdpbandwidth.SDPBandwidth bw) nothrowInsert bandwidth parameters into the array of bandwidths in msg at index idx. When -1 is given as idx, the bandwidth is inserted at the end.
gstsdp.types.SDPResult insertEmail(int idx, string email) nothrowInsert email into the array of emails in msg at index idx. When -1 is given as idx, the email is inserted at the end.
gstsdp.types.SDPResult insertPhone(int idx, string phone) nothrowInsert phone into the array of phone numbers in msg at index idx. When -1 is given as idx, the phone is inserted at the end.
gstsdp.types.SDPResult insertTime(int idx, gstsdp.sdptime.SDPTime t) nothrowInsert time parameters into the array of times in msg at index idx. When -1 is given as idx, the times are inserted at the end.
gstsdp.types.SDPResult insertZone(int idx, gstsdp.sdpzone.SDPZone zone) nothrowInsert zone parameters into the array of zones in msg at index idx. When -1 is given as idx, the zone is inserted at the end.
uint mediasLen() nothrowGet the number of media descriptions in msg. Returns: the number of media descriptions in msg.
gstsdp.types.SDPResult parseKeymgmt(out gstsdp.mikeymessage.MIKEYMessage mikey) nothrowCreates a new #GstMIKEYMessage after parsing the key-mgmt attribute from a #GstSDPMessage.
uint phonesLen() nothrowGet the number of phones in msg. Returns: the number of phones in msg.
gstsdp.types.SDPResult removeAttribute(uint idx) nothrowRemove the attribute in msg at index idx.
gstsdp.types.SDPResult removeBandwidth(uint idx) nothrowRemove the bandwidth information in msg at index idx.
gstsdp.types.SDPResult removeEmail(uint idx) nothrowRemove the email in msg at index idx.
gstsdp.types.SDPResult removeMedia(uint idx) nothrowRemove the media at idx from the array of medias in msg if found.
gstsdp.types.SDPResult removePhone(uint idx) nothrowRemove the phone number in msg at index idx.
gstsdp.types.SDPResult removeTime(uint idx) nothrowRemove the time information in msg at index idx.
gstsdp.types.SDPResult removeZone(uint idx) nothrowRemove the zone information in msg at index idx.
gstsdp.types.SDPResult replaceAttribute(uint idx, gstsdp.sdpattribute.SDPAttribute attr) nothrowReplace the attribute in msg at index idx with attr.
gstsdp.types.SDPResult replaceBandwidth(uint idx, gstsdp.sdpbandwidth.SDPBandwidth bw) nothrowReplace the bandwidth information in msg at index idx with bw.
gstsdp.types.SDPResult replaceEmail(uint idx, string email) nothrowReplace the email in msg at index idx with email.
gstsdp.types.SDPResult replacePhone(uint idx, string phone) nothrowReplace the phone number in msg at index idx with phone.
gstsdp.types.SDPResult replaceTime(uint idx, gstsdp.sdptime.SDPTime t) nothrowReplace the time information in msg at index idx with `t`.
gstsdp.types.SDPResult replaceZone(uint idx, gstsdp.sdpzone.SDPZone zone) nothrowReplace the zone information in msg at index idx with zone.
gstsdp.types.SDPResult setConnection(string nettype, string addrtype, string address, uint ttl, uint addrNumber) nothrowConfigure the SDP connection in msg with the given parameters.
gstsdp.types.SDPResult setInformation(string information) nothrowSet the information in msg.
gstsdp.types.SDPResult setKey(string type, string data) nothrowAdds the encryption information to msg.
gstsdp.types.SDPResult setOrigin(string username, string sessId, string sessVersion, string nettype, string addrtype, string addr) nothrowConfigure the SDP origin in msg with the given parameters.
gstsdp.types.SDPResult setSessionName(string sessionName) nothrowSet the session name in msg.
gstsdp.types.SDPResult setUri(string uri) nothrowSet the URI in msg.
gstsdp.types.SDPResult setVersion(string version_) nothrowSet the version in msg.
uint timesLen() nothrowGet the number of time information entries in msg. Returns: the number of time information entries in msg.
gstsdp.types.SDPResult uninit() nothrowFree all resources allocated in msg. msg should not be used anymore after this function. This function should be used when msg was allocated on the stack and initialized with [gstsdp.sdpmessage.SDP...
uint zonesLen() nothrowGet the number of time zone information entries in msg. Returns: the number of time zone information entries in msg.
string asUri(string scheme, gstsdp.sdpmessage.SDPMessage msg) static nothrowCreates a uri from msg with the given scheme. The uri has the format:
gstsdp.types.SDPResult init_(out gstsdp.sdpmessage.SDPMessage msg) static nothrowInitialize msg so that its contents are as if it was freshly allocated with [gstsdp.sdpmessage.SDPMessage.new_]. This function is mostly used to initialize a message allocated on the stack. [gstsdp...
gstsdp.types.SDPResult new_(out gstsdp.sdpmessage.SDPMessage msg) static nothrowAllocate a new GstSDPMessage and store the result in msg.
gstsdp.types.SDPResult newFromText(string text, out gstsdp.sdpmessage.SDPMessage msg) static nothrowParse text and create a new SDPMessage from these.
gstsdp.types.SDPResult parseBuffer(ubyte[] data, gstsdp.sdpmessage.SDPMessage msg) static nothrowParse the contents of size bytes pointed to by data and store the result in msg.
gstsdp.types.SDPResult parseUri(string uri, gstsdp.sdpmessage.SDPMessage msg) static nothrowParse the null-terminated uri and store the result in msg.
Constructors
this(string version_ = string.init, string sessionName = string.init, string information = string.init, string uri = string.init)Create a `sdpmessage.SDPMessage` boxed type. Params: version_ = the protocol version sessionName = session name information = session information uri = URI of description
this(void * ptr, Flag!"Take" take)