try_pull_preroll


Description:

[ HasEmitter ]
[ Version ( since = "1.10" ) ]
public virtual signal Sample? try_pull_preroll (uint64 timeout)

Get the last preroll sample in appsink.

This was the sample that caused the appsink to preroll in the PAUSED state.

This function is typically used when dealing with a pipeline in the PAUSED state. Calling this function after doing a seek will give the sample right after the seek position.

Calling this function will clear the internal reference to the preroll buffer.

Note that the preroll sample will also be returned as the first sample when calling pull_sample or the "pull-sample" action signal.

If an EOS event was received before any buffers or the timeout expires, this function returns null. Use gst_app_sink_is_eos () to check for the EOS condition.

This function blocks until a preroll sample or EOS is received, the appsink element is set to the READY/NULL state, or the timeout expires.

Parameters:

timeout

the maximum amount of time to wait for the preroll sample

Returns:

a Sample or null when the appsink is stopped or EOS or the timeout expires.