Class: Gst::Pipeline

Inherits:
Bin show all
Defined in:
(unknown)

Instance Method Summary collapse

Methods inherited from Bin

#<<, #add_elements, #add_many, #async_handling=, #async_handling?, #each, #find_unlinked_pad, #get_by_interface, #get_by_name, #get_by_name_recurse_up, #iterate_all_by_element_factory_name, #iterate_all_by_interface, #iterate_elements, #iterate_recurse, #iterate_sinks, #iterate_sorted, #iterate_sources, #message_forward=, #message_forward?, #recalculate_latency, #remove, #remove_many, #suppressed_flags, #suppressed_flags=, #sync_children_states

Methods inherited from Element

#>>, [], #abort_state, #add_metadata, #add_pad, #add_pad_template, #add_property_deep_notify_watch, #add_property_notify_watch, #add_static_metadata, #add_static_pad_template, #add_static_pad_template_with_gtype, #base_time, #base_time=, #bus=, #call_async, #change_state, #context=, #contexts, #continue_state, #create_all_pads, #current_clock_time, #current_running_time, #decorate_stream_id, #decorate_stream_id_printf, #decorate_stream_id_printf_valist, #factory, #flags, #flags_raw, #foreach_pad, #foreach_sink_pad, #foreach_src_pad, #get_compatible_pad, #get_compatible_pad_template, #get_context, #get_context_unlocked, #get_metadata, #get_pad_template, #get_request_pad, #get_state, #get_static_pad, #is_locked_state, #iterate_pads, #iterate_sink_pads, #iterate_src_pads, #link_elements, #link_filtered, #link_many, #link_pads, #link_pads_filtered, #link_pads_full, #locked_state=, #lost_state, make_from_uri, #message_full, #message_full_with_details, #no_more_pads, #pad_template_list, #pause, #play, #post_message, #provide_clock, #query, #query_convert, #query_duration, #query_position, #ready, register, #release_request_pad, #remove_pad, #remove_property_notify_watch, #request_pad, #request_pad_simple, #seek, #seek_simple, #send_event, #set_metadata, #set_static_metadata, #start_time, #start_time=, #state=, state_change_return_get_name, state_get_name, #stop, #sync_state_with_parent, type_set_skip_documentation, #unlink, #unlink_many, #unlink_pads

Methods inherited from Object

#add_control_binding, check_uniqueness, #control_bindings_disabled=, #control_rate, #control_rate=, default_deep_notify, #default_error, #get_control_binding, #get_g_value_array, #get_value, #get_value_array, #has_active_control_bindings, #has_ancestor, #has_as_ancestor, #has_as_parent, #name, #name=, #parent, #parent=, #path_string, #ref, ref_sink, #remove_control_binding, replace, #set_control_binding_disabled, #suggest_next_sync, #sync_values, #unparent, #unref

Constructor Details

#initialize(name) ⇒ Gst::Element

Create a new pipeline with the given name. MT safe.

Parameters:

  • name (String) —

    name of new pipeline

Instance Method Details

#auto_clock ⇒ nil

Let pipeline select a clock automatically. This is the default behaviour.

Use this function if you previous forced a fixed clock with gst_pipeline_use_clock() and want to restore the default pipeline clock selection algorithm.

MT safe.

Returns:

  • (nil)

#auto_flush_bus ⇒ Boolean

Check if pipeline will automatically flush messages when going to the NULL state. going from READY to NULL state or not.

MT safe.

Returns:

  • (Boolean) —

    whether the pipeline will automatically flush its bus when

#auto_flush_bus=(auto_flush_bus) ⇒ Boolean

Whether or not to automatically flush all messages on the pipeline's bus when going from READY to NULL state. Please see gst_pipeline_set_auto_flush_bus() for more information on this option.

Parameters:

  • auto_flush_bus (Boolean)

Returns:

  • (Boolean) —

    auto-flush-bus

  • (Boolean) —

    auto-flush-bus

#auto_flush_bus? ⇒ Boolean

Whether or not to automatically flush all messages on the pipeline's bus when going from READY to NULL state. Please see gst_pipeline_set_auto_flush_bus() for more information on this option.

Returns:

  • (Boolean) —

    auto-flush-bus

#bus ⇒ Gst::Bus

Gets the Gst::Bus of pipeline. The bus allows applications to receive Gst::Message packets. MT safe.

Returns:

  • (Gst::Bus) —

    a Gst::Bus, unref after usage.

#clock ⇒ Gst::Clock

Gets the current clock used by pipeline. Users of object oriented languages should use gst_pipeline_get_pipeline_clock() to avoid confusion with gst_element_get_clock() which has a different behavior.

Unlike gst_element_get_clock(), this function will always return a clock, even if the pipeline is not in the PLAYING state.

Returns:

  • (Gst::Clock) —

    a Gst::Clock, unref after usage.

#clock=(clock) ⇒ Boolean

Set the clock for pipeline. The clock will be distributed to all the elements managed by the pipeline. MT safe.

Parameters:

Returns:

  • (Boolean) —

    true if the clock could be set on the pipeline. false if some element did not accept the clock.

#configured_latency ⇒ Gst::ClockTime

Return the configured latency on pipeline. because pipeline did not reach the PLAYING state yet.

MT safe.

Returns:

  • (Gst::ClockTime) —

    pipeline configured latency, or %GST_CLOCK_TIME_NONE if none has been configured

#delay ⇒ Integer

The expected delay needed for elements to spin up to the PLAYING state expressed in nanoseconds. see gst_pipeline_set_delay() for more information on this option.

Returns:

  • (Integer) —

    delay

#delay=(delay) ⇒ Integer

The expected delay needed for elements to spin up to the PLAYING state expressed in nanoseconds. see gst_pipeline_set_delay() for more information on this option.

Parameters:

  • delay (Integer)

Returns:

  • (Integer) —

    delay

  • (Integer) —

    delay

#is_live ⇒ Boolean

Check if pipeline is live. MT safe.

Returns:

  • (Boolean) —

    true if pipeline is live, false if not or if it did not reach the PAUSED state yet.

#latency ⇒ Integer

Latency to configure on the pipeline. See gst_pipeline_set_latency().

Returns:

  • (Integer) —

    latency

#latency=(latency) ⇒ Integer

Latency to configure on the pipeline. See gst_pipeline_set_latency().

Parameters:

  • latency (Integer)

Returns:

  • (Integer) —

    latency

  • (Integer) —

    latency

#pipeline_clock ⇒ Gst::Clock

Gets the current clock used by pipeline.

Unlike gst_element_get_clock(), this function will always return a clock, even if the pipeline is not in the PLAYING state.

Returns:

  • (Gst::Clock) —

    a Gst::Clock, unref after usage.

#use_clock(clock) ⇒ nil

Force pipeline to use the given clock. The pipeline will always use the given clock even if new clock providers are added to this pipeline.

If clock is nil all clocking will be disabled which will make the pipeline run as fast as possible.

MT safe.

Parameters:

Returns:

  • (nil)