Skip to content
GitLab
Menu
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
Zeeshan Ali
gstreamer-rs
Commits
7642441d
Commit
7642441d
authored
Dec 22, 2017
by
Sebastian Dröge
🍵
Browse files
Update documentation
parent
9b6efb23
Changes
6
Expand all
Hide whitespace changes
Inline
Side-by-side
docs/gstreamer-app/docs.md
View file @
7642441d
...
...
@@ -39,7 +39,7 @@ to avoid polling.
# Implements
[
`BaseSinkExt`
](
trait.BaseSinkExt.html
)
,
[
`ElementExt`
](
trait.ElementExt.html
)
,
[
`ObjectExt`
](
trait.ObjectExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
,
[
`URIHandlerExt`
](
trait.URIHandlerExt.html
)
[
`
gst_base::
BaseSinkExt`
](
../gst_base/
trait.BaseSinkExt.html
)
,
[
`
gst::
ElementExt`
](
../gst/
trait.ElementExt.html
)
,
[
`
gst::
ObjectExt`
](
../gst/
trait.ObjectExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
,
[
`
gst::
URIHandlerExt`
](
../gst/
trait.URIHandlerExt.html
)
<!-- impl AppSink::fn get_buffer_list_support -->
Check if
`self`
supports buffer lists.
...
...
@@ -422,7 +422,7 @@ occurs or the state of the appsrc has gone through READY.
# Implements
[
`BaseSrcExt`
](
trait.BaseSrcExt.html
)
,
[
`ElementExt`
](
trait.ElementExt.html
)
,
[
`ObjectExt`
](
trait.ObjectExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
,
[
`URIHandlerExt`
](
trait.URIHandlerExt.html
)
[
`
gst_base::
BaseSrcExt`
](
../gst_base/
trait.BaseSrcExt.html
)
,
[
`
gst::
ElementExt`
](
../gst/
trait.ElementExt.html
)
,
[
`
gst::
ObjectExt`
](
../gst/
trait.ObjectExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
,
[
`
gst::
URIHandlerExt`
](
../gst/
trait.URIHandlerExt.html
)
<!-- impl AppSrc::fn end_of_stream -->
Indicates to the appsrc element that the last buffer queued in the
element is the last buffer of the stream.
...
...
docs/gstreamer-base/docs.md
View file @
7642441d
...
...
@@ -103,7 +103,7 @@ buffer pushed in it.
# Implements
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- impl Adapter::fn new -->
Creates a new
`Adapter`
. Free with
`gobject::ObjectExt::unref`
.
...
...
@@ -664,7 +664,7 @@ with non-synchronized streams or sparse streams.
# Implements
[
`BaseSinkExt`
](
trait.BaseSinkExt.html
)
,
[
`ElementExt`
](
trait.ElementExt.html
)
,
[
`ObjectExt`
](
trait.ObjectExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`BaseSinkExt`
](
trait.BaseSinkExt.html
)
,
[
`
gst::
ElementExt`
](
../gst/
trait.ElementExt.html
)
,
[
`
gst::
ObjectExt`
](
../gst/
trait.ObjectExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- trait BaseSinkExt -->
Trait containing all
`BaseSink`
methods.
...
...
@@ -1126,7 +1126,7 @@ received, it may safely shut down the entire pipeline.
# Implements
[
`BaseSrcExt`
](
trait.BaseSrcExt.html
)
,
[
`ElementExt`
](
trait.ElementExt.html
)
,
[
`ObjectExt`
](
trait.ObjectExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`BaseSrcExt`
](
trait.BaseSrcExt.html
)
,
[
`
gst::
ElementExt`
](
../gst/
trait.ElementExt.html
)
,
[
`
gst::
ObjectExt`
](
../gst/
trait.ObjectExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- trait BaseSrcExt -->
Trait containing all
`BaseSrc`
methods.
...
...
@@ -1403,7 +1403,7 @@ It provides for:
# Implements
[
`BaseTransformExt`
](
trait.BaseTransformExt.html
)
,
[
`ElementExt`
](
trait.ElementExt.html
)
,
[
`ObjectExt`
](
trait.ObjectExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`BaseTransformExt`
](
trait.BaseTransformExt.html
)
,
[
`
gst::
ElementExt`
](
../gst/
trait.ElementExt.html
)
,
[
`
gst::
ObjectExt`
](
../gst/
trait.ObjectExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- trait BaseTransformExt -->
Trait containing all
`BaseTransform`
methods.
...
...
@@ -1641,4 +1641,4 @@ base class.
# Implements
[
`BaseSrcExt`
](
trait.BaseSrcExt.html
)
,
[
`ElementExt`
](
trait.ElementExt.html
)
,
[
`ObjectExt`
](
trait.ObjectExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`BaseSrcExt`
](
trait.BaseSrcExt.html
)
,
[
`
gst::
ElementExt`
](
../gst/
trait.ElementExt.html
)
,
[
`
gst::
ObjectExt`
](
../gst/
trait.ObjectExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
docs/gstreamer-net/docs.md
View file @
7642441d
...
...
@@ -25,7 +25,7 @@ statistics about clock accuracy and network traffic.
# Implements
[
`ClockExt`
](
trait.ClockExt.html
)
,
[
`ObjectExt`
](
trait.ObjectExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`
gst::
ClockExt`
](
../gst/
trait.ClockExt.html
)
,
[
`
gst::
ObjectExt`
](
../gst/
trait.ObjectExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- impl NetClientClock::fn new -->
Create a new
`GstNetClientInternalClock`
that will report the time
provided by the
`NetTimeProvider`
on
`remote_address`
and
...
...
@@ -56,7 +56,7 @@ The `NetTimeProvider` typically wraps the clock used by a `gst::Pipeline`.
# Implements
[
`ObjectExt`
](
trait.ObjectExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`
gst::
ObjectExt`
](
../gst/
trait.ObjectExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- impl NetTimeProvider::fn new -->
Allows network clients to get the current time of
`clock`
.
## `clock`
...
...
@@ -75,7 +75,7 @@ the new `NetTimeProvider`, or NULL on error
# Implements
[
`NetClientClockExt`
](
trait.NetClientClockExt.html
)
,
[
`ClockExt`
](
trait.ClockExt.html
)
,
[
`ObjectExt`
](
trait.ObjectExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`NetClientClockExt`
](
trait.NetClientClockExt.html
)
,
[
`
gst::
ClockExt`
](
../gst/
trait.ClockExt.html
)
,
[
`
gst::
ObjectExt`
](
../gst/
trait.ObjectExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- impl NtpClock::fn new -->
Create a new
`NtpClock`
that will report the time provided by
the NTPv4 server on
`remote_address`
and
`remote_port`
.
...
...
@@ -117,7 +117,7 @@ synchronization.
# Implements
[
`ClockExt`
](
trait.ClockExt.html
)
,
[
`ObjectExt`
](
trait.ObjectExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`
gst::
ClockExt`
](
../gst/
trait.ClockExt.html
)
,
[
`
gst::
ObjectExt`
](
../gst/
trait.ObjectExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- impl PtpClock::fn new -->
Creates a new PTP clock instance that exports the PTP time of the master
clock in
`domain`
. This clock can be slaved to other clocks as needed.
...
...
docs/gstreamer-player/docs.md
View file @
7642441d
...
...
@@ -4,7 +4,7 @@
# Implements
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- impl Player::fn new -->
Creates a new
`Player`
instance that uses
`signal_dispatcher`
to dispatch
signals to some event loop system, or emits signals directly if NULL is
...
...
@@ -394,7 +394,7 @@ in the stream.
# Implements
[
`PlayerStreamInfoExt`
](
trait.PlayerStreamInfoExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`PlayerStreamInfoExt`
](
trait.PlayerStreamInfoExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- impl PlayerAudioInfo::fn get_bitrate -->
# Returns
...
...
@@ -438,7 +438,7 @@ generic error.
# Implements
[
`
ObjectExt`
](
trait.ObjectExt.html
)
,
[
`PlayerSignalDispatcherExt`
](
trait.PlayerSignalDispatcherExt.html
)
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
,
[
`PlayerSignalDispatcherExt`
](
trait.PlayerSignalDispatcherExt.html
)
<!-- impl PlayerGMainContextSignalDispatcher::fn new -->
Creates a new GstPlayerSignalDispatcher that uses
`application_context`
,
or the thread default one if
`None`
is used. See
`gst_player_new_full`
.
...
...
@@ -453,7 +453,7 @@ Structure containing the media information of a URI.
# Implements
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- impl PlayerMediaInfo::fn get_audio_streams -->
# Returns
...
...
@@ -570,7 +570,7 @@ the stream type, one can find more media-specific information in
# Implements
[
`PlayerStreamInfoExt`
](
trait.PlayerStreamInfoExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`PlayerStreamInfoExt`
](
trait.PlayerStreamInfoExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- trait PlayerStreamInfoExt -->
Trait containing all
`PlayerStreamInfo`
methods.
...
...
@@ -611,7 +611,7 @@ the tags contained in this stream.
# Implements
[
`PlayerStreamInfoExt`
](
trait.PlayerStreamInfoExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`PlayerStreamInfoExt`
](
trait.PlayerStreamInfoExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- impl PlayerSubtitleInfo::fn get_language -->
# Returns
...
...
@@ -622,7 +622,7 @@ the language of the stream, or NULL if unknown.
# Implements
[
`PlayerStreamInfoExt`
](
trait.PlayerStreamInfoExt.html
)
,
[
`
ObjectExt`
](
trait.ObjectExt.html
)
[
`PlayerStreamInfoExt`
](
trait.PlayerStreamInfoExt.html
)
,
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
<!-- impl PlayerVideoInfo::fn get_bitrate -->
# Returns
...
...
@@ -659,7 +659,7 @@ the width of video in `PlayerVideoInfo`.
# Implements
[
`
ObjectExt`
](
trait.ObjectExt.html
)
,
[
`PlayerVideoRendererExt`
](
trait.PlayerVideoRendererExt.html
)
[
`
glib::object::ObjectExt`
](
../glib/object/
trait.ObjectExt.html
)
,
[
`PlayerVideoRendererExt`
](
trait.PlayerVideoRendererExt.html
)
<!-- impl PlayerVideoOverlayVideoRenderer::fn new -->
## `window_handle`
Window handle to use or
`None`
...
...
docs/gstreamer-video/docs.md
View file @
7642441d
...
...
@@ -471,6 +471,46 @@ frames contains both interlaced and
Each field has only half the amount of lines as noted in the
height property. This mode requires multiple GstVideoMeta metadata
to describe the fields.
<!-- enum VideoMultiviewFramePacking -->
`VideoMultiviewFramePacking`
represents the subset of
`VideoMultiviewMode`
values that can be applied to any video frame without needing extra metadata.
It can be used by elements that provide a property to override the
multiview interpretation of a video stream when the video doesn't contain
any markers.
This enum is used (for example) on playbin, to re-interpret a played
video stream as a stereoscopic video. The individual enum values are
equivalent to and have the same value as the matching
`VideoMultiviewMode`
.
<!-- enum VideoMultiviewFramePacking::variant None -->
A special value indicating
no frame packing info.
<!-- enum VideoMultiviewFramePacking::variant Mono -->
All frames are monoscopic.
<!-- enum VideoMultiviewFramePacking::variant Left -->
All frames represent a left-eye view.
<!-- enum VideoMultiviewFramePacking::variant Right -->
All frames represent a right-eye view.
<!-- enum VideoMultiviewFramePacking::variant SideBySide -->
Left and right eye views are
provided in the left and right half of the frame respectively.
<!-- enum VideoMultiviewFramePacking::variant SideBySideQuincunx -->
Left and right eye
views are provided in the left and right half of the frame, but
have been sampled using quincunx method, with half-pixel offset
between the 2 views.
<!-- enum VideoMultiviewFramePacking::variant ColumnInterleaved -->
Alternating vertical
columns of pixels represent the left and right eye view respectively.
<!-- enum VideoMultiviewFramePacking::variant RowInterleaved -->
Alternating horizontal
rows of pixels represent the left and right eye view respectively.
<!-- enum VideoMultiviewFramePacking::variant TopBottom -->
The top half of the frame
contains the left eye, and the bottom half the right eye.
<!-- enum VideoMultiviewFramePacking::variant Checkerboard -->
Pixels are arranged with
alternating pixels representing left and right eye views in a
checkerboard fashion.
<!-- enum VideoMultiviewMode -->
All possible stereoscopic 3D and multiview representations.
In conjunction with
`VideoMultiviewFlags`
, describes how
...
...
docs/gstreamer/docs.md
View file @
7642441d
This diff is collapsed.
Click to expand it.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment