Clapper.StreamList¶

Subclasses:: None

Methods¶

Inherited:: Gst.Object (27), GObject.Object (37), Gio.ListModel (4)
Structs:: GObject.ObjectClass (5)

	`get_current_index` ()
	`get_current_stream` ()
	`get_n_streams` ()
	`get_stream` (index)
	`select_index` (index)
	`select_stream` (stream)

Virtual Methods¶

Inherited:: Gst.Object (1), GObject.Object (7), Gio.ListModel (3)

Properties¶

Inherited:: Gst.Object (2)

Name	Type	Flags	Short Description
`current-index`	`int`	r/w/en
`current-stream`	`Clapper.Stream`	r/en
`n-streams`	`int`	r/en

Signals¶

Inherited:: Gst.Object (1), GObject.Object (1), Gio.ListModel (1)

Fields¶

Inherited:: Gst.Object (1), GObject.Object (1), Gio.ListModel (1)

Class Details¶

class Clapper.StreamList(**kwargs)¶

Bases:: Gst.Object, Gio.ListModel
Abstract:: No
Structure:: Clapper.StreamListClass

A list of media streams.

get_current_index()¶

Returns:: Current stream index or [const`Clapper`.STREAM_LIST_INVALID_POSITION] when nothing is selected.
Return type:: int

Get index of the currently selected Clapper.Stream.

get_current_stream()¶

Returns:: The current Clapper.Stream.
Return type:: Clapper.Stream or None

Get the currently selected Clapper.Stream.

get_n_streams()¶

Returns:: The number of streams in Clapper.StreamList.
Return type:: int

Get the number of streams in Clapper.StreamList.

This behaves the same as [method`Gio`.ListModel.get_n_items], and is here for code uniformity and convenience to avoid type casting by user.

get_stream(index)¶

Parameters:: index (int) – a stream index
Returns:: The Clapper.Stream at index.
Return type:: Clapper.Stream or None

Get the Clapper.Stream at index.

This behaves the same as [method`Gio`.ListModel.get_item], and is here for code uniformity and convenience to avoid type casting by user.

select_index(index)¶

Parameters:: index (int) – a stream index
Returns:: True if stream could be selected, False otherwise.
Return type:: bool

Selects Clapper.Stream at index from self as current one.

select_stream(stream)¶

Parameters:: stream (Clapper.Stream) – a Clapper.Stream
Returns:: True if stream was in the self, False otherwise.
Return type:: bool

Selects Clapper.Stream from self to be activated.

Property Details¶

Clapper.StreamList.props.current_index¶

Name:: current-index
Type:: int
Default Value:: 4294967295
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Index of currently selected stream.

Clapper.StreamList.props.current_stream¶

Name:: current-stream
Type:: Clapper.Stream
Default Value:: None
Flags:: READABLE, EXPLICIT_NOTIFY

Currently selected stream.

Clapper.StreamList.props.n_streams¶

Name:: n-streams
Type:: int
Default Value:: 0
Flags:: READABLE, EXPLICIT_NOTIFY

Number of streams in the list.