Back to Seed Clases

Gst

Classes

Interfaces

Structs

Unions

Enums

Struct Gst.Message

Import line:	Gst = imports.gi.Gst;
GIR File:	Gst-0.10.gir
C documentation:	GstMessage
Struct :	Message
	Show / Hide Inherited methods, properties and signals

A GstMessage.

Properties
Properties		Defined By
	cond : GLib.Cond	Gst.Message
	lock : GLib.Mutex	Gst.Message
	mini_object : Gst.MiniObject	Gst.Message
	src : Gst.Object	Gst.Message
	structure : Gst.Structure	Gst.Message
	timestamp : Number	Gst.Message
	type : Gst.MessageType	Gst.Message

Methods / Constructors
Method / Constructor		Defined By
	new Gst.Message () Create a new Gst.Message Create a new Gst.Message
	new Gst.Message.application (Object *src, Structure structure) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.Structure structure Required (not null) Returns: Gst.Message
	new Gst.Message.async_done (Object *src) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Returns: Gst.Message
	new Gst.Message.async_start (Object *src, Boolean new_base_time) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Boolean new_base_time Required (not null) Returns: Gst.Message
	new Gst.Message.buffering (Object *src, Number percent) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Number percent Required (not null) Returns: Gst.Message
	new Gst.Message.clock_lost (Object *src, Clock clock) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.Clock clock Required (not null) Returns: Gst.Message
	new Gst.Message.clock_provide (Object *src, Clock clock, Boolean ready) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.Clock clock Required (not null) Boolean ready Required (not null) Returns: Gst.Message
	new Gst.Message.custom (MessageType *type, Object src, Structure structure) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.MessageType type* Required (not null) Gst.Object src Required (not null) Gst.Structure structure Required (not null) Returns: Gst.Message
	new Gst.Message.duration (Object *src, Format format, Number duration) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.Format format Required (not null) Number duration Required (not null) Returns: Gst.Message
	new Gst.Message.element (Object *src, Structure structure) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.Structure structure Required (not null) Returns: Gst.Message
	new Gst.Message.eos (Object *src) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Returns: Gst.Message
	new Gst.Message.error (Object *src, Object error, String debug) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Object error Required (not null) String debug Required (not null) Returns: Gst.Message
	new Gst.Message.info (Object *src, Object error, String debug) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Object error Required (not null) String debug Required (not null) Returns: Gst.Message
	new Gst.Message.latency (Object *src) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Returns: Gst.Message
	new Gst.Message.new_clock (Object *src, Clock clock) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.Clock clock Required (not null) Returns: Gst.Message
	new Gst.Message.qos (Object *src, Boolean live, Number running_time, Number stream_time, Number timestamp, Number duration) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Boolean live Required (not null) Number running_time Required (not null) Number stream_time Required (not null) Number timestamp Required (not null) Number duration Required (not null) Returns: Gst.Message
	new Gst.Message.request_state (Object *src, State state) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.State state Required (not null) Returns: Gst.Message
	new Gst.Message.segment_done (Object *src, Format format, Number position) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.Format format Required (not null) Number position Required (not null) Returns: Gst.Message
	new Gst.Message.segment_start (Object *src, Format format, Number position) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.Format format Required (not null) Number position Required (not null) Returns: Gst.Message
	new Gst.Message.state_changed (Object *src, State oldstate, State newstate, State pending) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.State oldstate Required (not null) Gst.State newstate Required (not null) state Gst.State pending Required (not null) state Returns: Gst.Message
	new Gst.Message.state_dirty (Object *src) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Returns: Gst.Message
	new Gst.Message.step_done (Object *src, Format format, Number amount, Number rate, Boolean flush, Boolean intermediate, Number duration, Boolean eos) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.Format format Required (not null) Number amount Required (not null) Number rate Required (not null) Boolean flush Required (not null) Boolean intermediate Required (not null) Number duration Required (not null) Boolean eos Required (not null) Returns: Gst.Message
	new Gst.Message.step_start (Object *src, Boolean active, Format format, Number amount, Number rate, Boolean flush, Boolean intermediate) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Boolean active Required (not null) Gst.Format format Required (not null) Number amount Required (not null) Number rate Required (not null) Boolean flush Required (not null) Boolean intermediate Required (not null) Returns: Gst.Message
	new Gst.Message.stream_status (Object *src, StreamStatusType type, Element owner) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.StreamStatusType type Required (not null) Gst.Element owner Required (not null) Returns: Gst.Message
	new Gst.Message.structure_change (Object *src, StructureChangeType type, Element owner, Boolean busy) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.StructureChangeType type Required (not null) Gst.Element owner Required (not null) Boolean busy Required (not null) Returns: Gst.Message
	new Gst.Message.tag (Object *src, TagList tag_list) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.TagList tag_list Required (not null) Returns: Gst.Message
	new Gst.Message.tag_full (Object *src, Pad pad, TagList tag_list) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Gst.Pad pad Required (not null) Gst.TagList tag_list Required (not null) Returns: Gst.Message
	new Gst.Message.warning (Object *src, Object error, String debug) : Gst.Message Create a new Gst.Message Create a new Gst.Message Parameters: Gst.Object src* Required (not null) Object error Required (not null) String debug Required (not null) Returns: Gst.Message
	get_seqnum () : Number Retrieve the sequence number of a message. Retrieve the sequence number of a message. Messages have ever-incrementing sequence numbers, which may also be set explicitly via gst_message_set_seqnum(). Sequence numbers are typically used to indicate that a message corresponds to some other set of messages or events, for example a SEGMENT_DONE message corresponding to a SEEK event. It is considered good practice to make this correspondence when possible, though it is not required. Note that events and messages share the same sequence number incrementor; two events or messages will never not have the same sequence number unless that correspondence was made explicitly. MT safe. Returns: Number	Gst.Message
	get_stream_status_object () : GObject.Value Extracts the object managing the streaming thread from message. Extracts the object managing the streaming thread from message. This object is usually of type GstTask but other types can be added in the future. The object remains valid as long as message is valid. Returns: GObject.Value	Gst.Message
	get_structure () : Gst.Structure Access the structure of the message. Access the structure of the message. owned by the message, which means that you should not free it and that the pointer becomes invalid when you free the message. MT safe. Returns: Gst.Structure	Gst.Message
	parse_async_start () : Boolean Extract the new_base_time from the async_start message. Extract the new_base_time from the async_start message. MT safe. Returns: Boolean	Gst.Message
	parse_buffering () : Number Extracts the buffering percent from the GstMessage. Extracts the buffering percent from the GstMessage. see also gst_message_new_buffering(). MT safe. Returns: Number	Gst.Message
	parse_buffering_stats (BufferingMode *mode) : Object Extracts the buffering stats values from message. Extracts the buffering stats values from message. Parameters: Gst.BufferingMode mode* Required (not null) Returns: avg_in: Number avg_out: Number buffering_left: Number	Gst.Message
	parse_clock_lost (Clock *clock) : none Extracts the lost clock from the GstMessage. Extracts the lost clock from the GstMessage. The clock object returned remains valid until the message is freed. MT safe. Parameters: Gst.Clock clock* Required (not null) Returns: none	Gst.Message
	parse_clock_provide (Clock *clock) : Boolean Extracts the clock and ready flag from the GstMessage. Extracts the clock and ready flag from the GstMessage. The clock object returned remains valid until the message is freed. MT safe. Parameters: Gst.Clock clock* Required (not null) Returns: Boolean	Gst.Message
	parse_duration (Format *format) : Number Extracts the duration and format from the duration message. Extracts the duration and format from the duration message. The duration might be GST_CLOCK_TIME_NONE, which indicates that the duration has changed. Applications should always use a query to retrieve the duration of a pipeline. MT safe. Parameters: Gst.Format format* Required (not null) Returns: Number	Gst.Message
	parse_error (Object *gerror, Array debug) : none Extracts the GError and debug string from the GstMessage. Extracts the GError and debug string from the GstMessage. The values returned in the output arguments are copies; the caller must free them when done. MT safe. Parameters: Object gerror* Required (not null) Array debug Required (not null) Returns: none	Gst.Message
	parse_info (Object *gerror, Array debug) : none Extracts the GError and debug string from the GstMessage. Extracts the GError and debug string from the GstMessage. The values returned in the output arguments are copies; the caller must free them when done. MT safe. Parameters: Object gerror* Required (not null) Array debug Required (not null) Returns: none	Gst.Message
	parse_new_clock (Clock *clock) : none Extracts the new clock from the GstMessage. Extracts the new clock from the GstMessage. The clock object returned remains valid until the message is freed. MT safe. Parameters: Gst.Clock clock* Required (not null) Returns: none	Gst.Message
	parse_qos () : Object Extract the timestamps and live status from the QoS message. Extract the timestamps and live status from the QoS message. The returned values give the running_time, stream_time, timestamp and duration of the dropped buffer. Values of GST_CLOCK_TIME_NONE mean unknown values. MT safe. Returns: live: Boolean running_time: Number stream_time: Number timestamp: Number duration: Number	Gst.Message
	parse_qos_stats (Format *format) : Object filters will use GST_FORMAT_BUFFERS (frames). filters will use GST_FORMAT_BUFFERS (frames). Audio sinks and audio filters will likely use GST_FORMAT_DEFAULT (samples). change to READY or a flushing operation. or a flushing operation. Extract the QoS stats representing the history of the current continuous pipeline playback period. When format* is GST_FORMAT_UNDEFINED both dropped and processed are invalid. Values of -1 for either processed or dropped mean unknown values. MT safe. Parameters: Gst.Format format Required (not null) Returns: processed: Number dropped: Number	Gst.Message
	parse_qos_values () : Object to get optimal quality. to get optimal quality. quality level of the element. The default maximum quality is 1000000. Extract the QoS values that have been calculated/analysed from the QoS data MT safe. Returns: jitter: Number proportion: Number quality: Number	Gst.Message
	parse_request_state (State *state) : none Extract the requested state from the request_state message. Extract the requested state from the request_state message. MT safe. Parameters: Gst.State state* Required (not null) Returns: none	Gst.Message
	parse_segment_done (Format *format) : Number Extracts the position and format from the segment start message. Extracts the position and format from the segment start message. MT safe. Parameters: Gst.Format format* Required (not null) Returns: Number	Gst.Message
	parse_segment_start (Format *format) : Number Extracts the position and format from the segment start message. Extracts the position and format from the segment start message. MT safe. Parameters: Gst.Format format* Required (not null) Returns: Number	Gst.Message
	parse_state_changed (State *oldstate, State newstate, State pending) : none Extracts the old and new states from the GstMessage. Extracts the old and new states from the GstMessage. MT safe. Parameters: Gst.State oldstate* Required (not null) Gst.State newstate Required (not null) state, or NULL Gst.State pending Required (not null) state, or NULL Returns: none	Gst.Message
	parse_step_done (Format *format) : Object Extract the values the step_done message. Extract the values the step_done message. MT safe. Parameters: Gst.Format format* Required (not null) Returns: amount: Number rate: Number flush: Boolean intermediate: Boolean duration: Number eos: Boolean	Gst.Message
	parse_step_start (Boolean *active, Format format) : Object Extract the values from step_start message. Extract the values from step_start message. MT safe. Parameters: Boolean active* Required (not null) Gst.Format format Required (not null) Returns: active: Boolean amount: Number rate: Number flush: Boolean intermediate: Boolean	Gst.Message
	parse_stream_status (StreamStatusType *type, Element owner) : none Extracts the stream status type and owner the GstMessage. Extracts the stream status type and owner the GstMessage. The returned owner remains valid for as long as the reference to message* is valid and should thus not be unreffed. MT safe. Parameters: Gst.StreamStatusType type Required (not null) Gst.Element owner Required (not null) Returns: none	Gst.Message
	parse_structure_change (StructureChangeType *type, Element owner) : Boolean completed Extracts the change type and completion status from the GstMessage. completed Extracts the change type and completion status from the GstMessage. MT safe. Parameters: Gst.StructureChangeType type* Required (not null) Gst.Element owner Required (not null) Returns: Boolean	Gst.Message
	parse_tag (TagList *tag_list) : none Extracts the tag list from the GstMessage. Extracts the tag list from the GstMessage. The tag list returned in the output argument is a copy; the caller must free it when done. MT safe. Parameters: Gst.TagList tag_list* Required (not null) Returns: none	Gst.Message
	parse_tag_full (Pad *pad, TagList tag_list) : none Extracts the tag list from the GstMessage. Extracts the tag list from the GstMessage. The tag list returned in the output argument is a copy; the caller must free it when done. MT safe. Parameters: Gst.Pad pad* Required (not null) Gst.TagList tag_list Required (not null) Returns: none	Gst.Message
	parse_warning (Object *gerror, Array debug) : none Extracts the GError and debug string from the GstMessage. Extracts the GError and debug string from the GstMessage. The values returned in the output arguments are copies; the caller must free them when done. MT safe. Parameters: Object gerror* Required (not null) Array debug Required (not null) Returns: none	Gst.Message
	set_buffering_stats (BufferingMode *mode, Number avg_in, Number avg_out, Number buffering_left) : none Configures the buffering stats values in message. Configures the buffering stats values in message. Parameters: Gst.BufferingMode mode* Required (not null) Number avg_in Required (not null) Number avg_out Required (not null) Number buffering_left Required (not null) Returns: none	Gst.Message
	set_qos_stats (Format *format, Number processed, Number dropped) : none filters will use GST_FORMAT_BUFFERS (frames). filters will use GST_FORMAT_BUFFERS (frames). Audio sinks and audio filters will likely use GST_FORMAT_DEFAULT (samples). change to READY or a flushing operation. or a flushing operation. Set the QoS stats representing the history of the current continuous pipeline playback period. When format* is GST_FORMAT_UNDEFINED both dropped and processed are invalid. Values of -1 for either processed or dropped mean unknown values. MT safe. Parameters: Gst.Format format Required (not null) Number processed Required (not null) Number dropped Required (not null) Returns: none	Gst.Message
	set_qos_values (Number *jitter, Number proportion, Number quality) : none to get optimal quality. to get optimal quality. quality level of the element. The default maximum quality is 1000000. Set the QoS values that have been calculated/analysed from the QoS data MT safe. Parameters: Number jitter* Required (not null) Number proportion Required (not null) Number quality Required (not null) Returns: none	Gst.Message
	set_seqnum (Number *seqnum) : none Set the sequence number of a message. Set the sequence number of a message. This function might be called by the creator of a message to indicate that the message relates to other messages or events. See gst_message_get_seqnum() for more information. MT safe. Parameters: Number seqnum* Required (not null) Returns: none	Gst.Message
	set_stream_status_object (Value *object) : none Configures the object handling the streaming thread. Configures the object handling the streaming thread. This is usually a GstTask object but other objects might be added in the future. Parameters: GObject.Value object* Required (not null) Returns: none	Gst.Message

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gst.Bus Signal	message (Bus *self, Message message*) : none A message has been posted on the bus.
Gst.Bus Signal	sync_message (Bus *self, Message message*) : none A message has been posted on the bus.
Gst.Bus Method	post (Message *message*) : Boolean Post a message on the given bus.
Gst.Bus Method	peek () : Gst.Message Peek the message on the top of the bus' queue.
Gst.Bus Method	pop () : Gst.Message Get a message from the bus.
Gst.Bus Method	pop_filtered (MessageType *types) : Gst.Message Get a message matching type* from the bus.
Gst.Bus Method	timed_pop (Number *timeout*) : Gst.Message Get a message from the bus, waiting up to the specified timeout.
Gst.Bus Method	timed_pop_filtered (Number *timeout, MessageType types) : Gst.Message Get a message from the bus whose type matches the message type mask types*, waiting up to the specified timeout (and discarding any messages that do not match the mask provided).
Gst.Bus Method	poll (MessageType *events, Number timeout*) : Gst.Message poll for.
Gst.Bus Method	async_signal_func (Message *message, void *data) : Boolean A helper GstBusFunc* that can be used to convert all asynchronous messages into signals.
Gst.Bus Method	sync_signal_handler (Message *message, void *data*) : Gst.BusSyncReply A helper GstBusSyncHandler that can be used to convert all synchronous messages into signals.
Gst.Element Method	post_message (Message *message) : Boolean Post a message on the element's GstBus*.
Gst.Event Method	new Gst.Event.sink_message (Message *msg*) : Gst.Event Create a new Gst.Event
Gst.Event Method	parse_sink_message (Message *msg*) : none Parse the sink-message event.
GstCheck Method	GstCheck.message_error (Message *message, MessageType type, Number domain, Number code*) : none
GstInterfaces Method	GstInterfaces.mixer_message_get_type (Message *message*) : GstInterfaces.MixerMessageType Check a bus message to see if it is a GstMixer notification message and return the GstMixerMessageType identifying which type of notification it is.
GstInterfaces Method	GstInterfaces.mixer_message_parse_mute_toggled (Message *message, MixerTrack track*) : Boolean Extracts the contents of a mute-toggled bus message.
GstInterfaces Method	GstInterfaces.mixer_message_parse_option_changed (Message *message, MixerOptions options, Array value*) : none Extracts the GstMixerOptions and new value from a option-changed bus notification message.
GstInterfaces Method	GstInterfaces.mixer_message_parse_options_list_changed (Message *message, MixerOptions options*) : none Extracts the GstMixerOptions whose value list has changed from an options-list-changed bus notification message.
GstInterfaces Method	GstInterfaces.mixer_message_parse_record_toggled (Message *message, MixerTrack track*) : Boolean Extracts the contents of a record-toggled bus message.
GstInterfaces Method	GstInterfaces.mixer_message_parse_volume_changed (Message *message, MixerTrack track*) : Object Parses a volume-changed notification message and extracts the track object it refers to, as well as an array of volumes and the size of the volumes array.
GstInterfaces Method	GstInterfaces.navigation_message_get_type (Message *message) : GstInterfaces.NavigationMessageType Check a bus message to see if it is a GstNavigation* event, and return the GstNavigationMessageType identifying the type of the message if so.
GstInterfaces Method	GstInterfaces.navigation_message_new_angles_changed (Object *src, Number cur_angle, Number n_angles) : Gst.Message Creates a new GstNavigation* message with type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED for notifying an application that the current angle, or current number of angles available in a multiangle video has changed.
GstInterfaces Method	GstInterfaces.navigation_message_new_commands_changed (Object *src) : Gst.Message Creates a new GstNavigation* message with type GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED
GstInterfaces Method	GstInterfaces.navigation_message_new_mouse_over (Object *src, Boolean active) : Gst.Message FALSE* if it over a non-clickable area.
GstInterfaces Method	GstInterfaces.navigation_message_parse_angles_changed (Message *message, Object out_values) : Boolean or NULL Parse a GstNavigation* message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED and extract the cur_angle and n_angles parameters.
GstInterfaces Method	GstInterfaces.navigation_message_parse_mouse_over (Message *message, Object out_values*) : Boolean or NULL.
GstPbutils Method	GstPbutils.is_missing_plugin_message (Message *msg) : Boolean Checks whether msg* is a missing plugins message.
GstPbutils Method	GstPbutils.missing_decoder_message_new (Element *element, Caps decode_caps) : Gst.Message Creates a missing-plugin message for element* to notify the application that a decoder element for a particular set of (fixed) caps is missing.
GstPbutils Method	GstPbutils.missing_element_message_new (Element *element, String factory_name) : Gst.Message Creates a missing-plugin message for element* to notify the application that a certain required element is missing.
GstPbutils Method	GstPbutils.missing_encoder_message_new (Element *element, Caps encode_caps) : Gst.Message Creates a missing-plugin message for element* to notify the application that an encoder element for a particular set of (fixed) caps is missing.
GstPbutils Method	GstPbutils.missing_plugin_message_get_description (Message *msg*) : String Returns a localised string describing the missing feature, for use in error dialogs and the like.
GstPbutils Method	GstPbutils.missing_plugin_message_get_installer_detail (Message *msg*) : String Returns an opaque string containing all the details about the missing element to be passed to an external installer called via gst_install_plugins_async() or gst_install_plugins_sync().
GstPbutils Method	GstPbutils.missing_uri_sink_message_new (Element *element, String protocol) : Gst.Message Creates a missing-plugin message for element* to notify the application that a sink element for a particular URI protocol is missing.
GstPbutils Method	GstPbutils.missing_uri_source_message_new (Element *element, String protocol) : Gst.Message Creates a missing-plugin message for element* to notify the application that a source element for a particular URI protocol is missing.

Un-official Seed Documentation

Gst

Classes

Interfaces

Structs

Unions

Enums

Struct Gst.Message