Table of Contents

Class Bus

Namespace
Gst
Assembly
Gst-1.0.dll
public class Bus : Object, IDisposable, NativeObject, GTypeProvider, InstanceFactory
Inheritance
Bus
Implements
Inherited Members

Constructors

Bus(params ConstructArgument[])

[Obsolete("Regular C# constructors on native classes will be removed in a future version. Please see the linked documentation for more details. It contains scenarios and possible solutions to prepare for the upcoming changes.", DiagnosticId = "GirCore1007", UrlFormat = "https://gircore.github.io/docs/integration/diagnostic/1007.html")]
public Bus(params ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

Bus(CreationData)

[Obsolete("This constructor is a workaround to keep legacy APIs alive. Do not use it.")]
protected Bus(CreationData data)

Parameters

data CreationData

Bus(BusHandle)

protected Bus(BusHandle handle)

Parameters

handle BusHandle

Fields

MessageSignal

Signal Descriptor for OnMessage.

public static readonly Signal<Bus, Bus.MessageSignalArgs> MessageSignal

Field Value

Signal<Bus, Bus.MessageSignalArgs>

SyncMessageSignal

Signal Descriptor for OnSyncMessage.

public static readonly Signal<Bus, Bus.SyncMessageSignalArgs> SyncMessageSignal

Field Value

Signal<Bus, Bus.SyncMessageSignalArgs>

Methods

AddSignalWatch()

public void AddSignalWatch()

AddSignalWatchFull(int)

public void AddSignalWatchFull(int priority)

Parameters

priority int

AddWatch(int, BusFunc)

public uint AddWatch(int priority, BusFunc func)

Parameters

priority int
func BusFunc

Returns

uint

AsyncSignalFunc(Message, nint)

public bool AsyncSignalFunc(Message message, nint data)

Parameters

message Message
data nint

Returns

bool

CreateWatch()

public Source? CreateWatch()

Returns

Source

DisableSyncMessageEmission()

public void DisableSyncMessageEmission()

EnableSyncMessageEmission()

public void EnableSyncMessageEmission()

GetGType()

public static Type GetGType()

Returns

Type

GetPollfd(out PollFD)

[Version("1.14")]
public void GetPollfd(out PollFD fd)

Parameters

fd PollFD

HavePending()

public bool HavePending()

Returns

bool

New()

public static Bus New()

Returns

Bus

NewFromPointer(nint, bool)

Creates a new managed Bus instance for a given pointer.

public static Bus NewFromPointer(nint ptr, bool ownsHandle)

Parameters

ptr nint
ownsHandle bool

Returns

Bus

NewWithProperties(ConstructArgument[])

Creates a new Bus and sets the properties specified by the construct arguments.

public static Bus NewWithProperties(ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

The properties to set.

Returns

Bus

Peek()

public Message? Peek()

Returns

Message

Poll(MessageType, ClockTime)

public Message? Poll(MessageType events, ClockTime timeout)

Parameters

events MessageType
timeout ClockTime

Returns

Message

Pop()

public Message? Pop()

Returns

Message

PopFiltered(MessageType)

public Message? PopFiltered(MessageType types)

Parameters

types MessageType

Returns

Message

Post(Message)

public bool Post(Message message)

Parameters

message Message

Returns

bool

RemoveSignalWatch()

public void RemoveSignalWatch()

RemoveWatch()

[Version("1.6")]
public bool RemoveWatch()

Returns

bool

SetFlushing(bool)

public void SetFlushing(bool flushing)

Parameters

flushing bool

SetSyncHandler(BusSyncHandler?)

public void SetSyncHandler(BusSyncHandler? func)

Parameters

func BusSyncHandler

SyncSignalHandler(Message, nint)

public BusSyncReply SyncSignalHandler(Message message, nint data)

Parameters

message Message
data nint

Returns

BusSyncReply

TimedPop(ClockTime)

public Message? TimedPop(ClockTime timeout)

Parameters

timeout ClockTime

Returns

Message

TimedPopFiltered(ClockTime, MessageType)

public Message? TimedPopFiltered(ClockTime timeout, MessageType types)

Parameters

timeout ClockTime
types MessageType

Returns

Message

Events

OnMessage

public event SignalHandler<Bus, Bus.MessageSignalArgs> OnMessage

Event Type

SignalHandler<Bus, Bus.MessageSignalArgs>

OnSyncMessage

public event SignalHandler<Bus, Bus.SyncMessageSignalArgs> OnSyncMessage

Event Type

SignalHandler<Bus, Bus.SyncMessageSignalArgs>