[−][src]Struct gst::Element

pub struct Element { /* fields omitted */ }

Methods

`impl Element`[src]

`pub fn new(factory_name: &str, element_name: &str) -> Option<Element>`[src]

Use a factory factory_name to create an element with name element_name.

`pub fn factory_make(element: &str, name: &str) -> Option<Element>`[src]

`pub unsafe fn new_from_gst_element(element: *mut GstElement) -> Option<Element>`[src]

`pub fn link_many(elements: &[&mut Element]) -> bool`[src]

Link several elements in succession.

Calling Element::link_many(&mut[&mut A, &mut B, &mut C, ...]) will attempt to link A->B, then B->C, ... . In case of error, this function returns immediately, without attempting to unlink.

See ElementT::link for more details about linking.

Make sure you have added your elements to a bin or pipeline with `Bin::add()`` before trying to link them.

returns true if all elements could be linked, false otherwise.

`pub fn link(&mut self, dst: &mut Element) -> bool`[src]

Links this element to dest . The link must be from source to destination; the other direction will not be tried. The function looks for existing pads that aren't linked yet. It will request new pads if necessary. Such pads need to be released manually when unlinking. If multiple links are possible, only one is established.

Make sure you have added your elements to a bin or pipeline with Bin::add() before trying to link them.

returns true if the elements could be linked, false otherwise.

`pub fn unlink(&mut self, dst: &mut Element)`[src]

Unlinks all source pads of the this element with all sink pads of the sink element to which they are linked.

If the link has been made using Element::link(), it could have created a requestpad, which has to be released using gst_element_release_request_pad().

`pub fn bus(&self) -> Option<Bus>`[src]

Returns the bus of the element. Note that only a Pipeline will provide a bus for the application.

`pub fn set_name(&mut self, name: &str)`[src]

Sets the name of the element

`pub fn set_state(&mut self, state: GstState) -> GstStateChangeReturn`[src]

Sets the state of the element. This function will try to set the requested state by going through all the intermediary states and calling the class's state change function for each.

This function can return GST_STATE_CHANGE_ASYNC, in which case the element will perform the remainder of the state change asynchronously in another thread. An application can use get_state() to wait for the completion of the state change or it can wait for a GST_MESSAGE_ASYNC_DONE or GST_MESSAGE_STATE_CHANGED on the bus.

State changes to GST_STATE_READY or GST_STATE_NULL never return GST_STATE_CHANGE_ASYNC.

`pub fn get_state( &self, timeout: GstClockTime ) -> (GstState, GstState, GstStateChangeReturn)`[src]

Gets the state of the element.

For elements that performed an ASYNC state change, as reported by set_state(), this function will block up to the specified timeout value for the state change to complete. If the element completes the state change or goes into an error, this function returns immediately with a return value of GST_STATE_CHANGE_SUCCESS or GST_STATE_CHANGE_FAILURE respectively.

For elements that did not return GST_STATE_CHANGE_ASYNC, this function returns the current and pending state immediately.

This function returns GST_STATE_CHANGE_NO_PREROLL if the element successfully changed its state but is not able to provide data yet. This mostly happens for live sources that only produce data in GST_STATE_PLAYING. While the state change return is equivalent to GST_STATE_CHANGE_SUCCESS, it is returned to the application to signal that some sink elements might not be able to complete their state change because an element is not producing data to complete the preroll. When setting the element to playing, the preroll will complete and playback will start. Returns

GST_STATE_CHANGE_SUCCESS if the element has no more pending state and the last state change succeeded, GST_STATE_CHANGE_ASYNC if the element is still performing a state change or GST_STATE_CHANGE_FAILURE if the last state change failed.

`pub unsafe fn send_event(&mut self, event: *mut GstEvent) -> bool`[src]

Sends an event to an element. If the element doesn't implement an event handler, the event will be pushed on a random linked sink pad for downstream events or a random linked source pad for upstream events.

This function takes ownership of the provided event so you should gst_event_ref() it if you want to reuse the event after this call.

`pub fn seek_simple( &mut self, format: GstFormat, flags: GstSeekFlags, pos: i64 ) -> bool`[src]

Simple API to perform a seek on the given element, meaning it just seeks to the given position relative to the start of the stream. For more complex operations like segment seeks (e.g. for looping) or changing the playback rate or seeking relative to the last configured playback segment you should use gst_element_seek().

In a completely prerolled PAUSED or PLAYING pipeline, seeking is always guaranteed to return TRUE on a seekable media type or FALSE when the media type is certainly not seekable (such as a live stream).

Some elements allow for seeking in the READY state, in this case they will store the seek event and execute it when they are put to PAUSED. If the element supports seek in READY, it will always return true when it receives the event in the READY state.

`pub fn seek( &mut self, rate: f64, format: GstFormat, flags: GstSeekFlags, start_type: GstSeekType, start: i64, stop_type: GstSeekType, stop: i64 ) -> bool`[src]

Sends a seek event to an element. See gst_event_new_seek() for the details of the parameters. The seek event is sent to the element using send_event().

`pub fn query_duration(&self, format: GstFormat) -> Option<i64>`[src]

Queries an element (usually top-level pipeline or playbin element) for the total stream duration in nanoseconds. This query will only work once the pipeline is prerolled (i.e. reached PAUSED or PLAYING state). The application will receive an ASYNC_DONE message on the pipeline bus when that is the case.

If the duration changes for some reason, you will get a DURATION_CHANGED message on the pipeline bus, in which case you should re-query the duration using this function.

`pub fn query_position(&self, format: GstFormat) -> Option<i64>`[src]

Queries an element (usually top-level pipeline or playbin element) for the stream position in nanoseconds. This will be a value between 0 and the stream duration (if the stream duration is known). This query will usually only work once the pipeline is prerolled (i.e. reached PAUSED or PLAYING state). The application will receive an ASYNC_DONE message on the pipeline bus when that is the case.