OwrBus

OwrBus

Functions

Properties

OwrMessageTypes message-type-mask Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── OwrBus

Description

Functions

OwrBusMessageCallback ()

void
(*OwrBusMessageCallback) (OwrMessageOrigin *origin,
                          OwrMessageType type,
                          OwrMessageSubType sub_type,
                          GHashTable *data,
                          gpointer user_data);

Parameters

origin

the origin of the message, an OwrMessageOrigin.

[transfer none]

type

the OwrMessageType of the message

 

sub_type

the OwrMessageSubType of the message

 

data

the data passed to owr_bus_set_message_callback.

[element-type utf8 GValue][nullable][transfer none]

user_data

the data passed to owr_bus_set_message_callback.

[nullable]

owr_bus_new ()

OwrBus *
owr_bus_new ();

owr_bus_set_message_callback ()

void
owr_bus_set_message_callback (OwrBus *bus,
                              OwrBusMessageCallback callback,
                              gpointer user_data,
                              GDestroyNotify destroy_data);

Parameters

bus

an OwrBus

 

callback

(scope notified)

 

user_data

user data for callback .

[nullable]

destroy_data

a GDestroyNotify for user_data .

[nullable]

owr_bus_add_message_origin ()

void
owr_bus_add_message_origin (OwrBus *bus,
                            OwrMessageOrigin *origin);

Adds a message origin to the bus, adding an already existing message origin has no effect.

Parameters

bus

the bus to which the message origin is added

 

origin

the message origin that is added to the bus.

[transfer none]

owr_bus_remove_message_origin ()

void
owr_bus_remove_message_origin (OwrBus *bus,
                               OwrMessageOrigin *origin);

Removes a message origin from the bus if it exists, otherwise nothing is done.

Parameters

bus

the bus from which the message origin should be removed

 

origin

the message origin that should be removed from the bus.

[transfer none]

Types and Values

enum OwrMessageSubType

OWR_ERROR_TYPE_PROCESSING_ERROR : a processing error occured, the origin of the error will likely not be able to produce or consume anymore data.

OWR_STATS_TYPE_SCHEDULE : information about a call that was scheduled on the main thread

  • function_name : utf8 the name of the function that scheduled the call

  • start_time : gint64 monotonic time when the call was scheduled

  • call_time : gint64 monotonic time when the function call started

  • end_time : gint64 monotonic time when the function call completed

OWR_STATS_TYPE_SEND_PIPELINE_ADDED : a send pipeline was added to a media session

  • start_time : gint64 monotonic time when the pipeline setup began

  • end_time : gint64 monotonic time when the pipeline setup was completed

OWR_STATS_TYPE_SEND_PIPELINE_REMOVED : a send pipeline was removed to a media session

  • start_time : gint64 monotonic time when the pipeline teardown began

  • end_time : gint64 monotonic time when the pipeline teardown was completed

OWR_EVENT_TYPE_RENDERER_STARTED : a renderer was started

OWR_EVENT_TYPE_RENDERER_STOPPED : a renderer was stopped

OWR_EVENT_TYPE_LOCAL_SOURCE_STARTED : a local media source was started

  • start_time : gint64 monotonic time when the pipeline setup began

  • end_time : gint64 monotonic time when the pipeline setup was completed

OWR_EVENT_TYPE_LOCAL_SOURCE_STOPPED : a local media source was stopped

  • start_time : gint64 monotonic time when the pipeline teardown began

  • end_time : gint64 monotonic time when the pipeline teardown was completed

Members

OWR_ERROR_TYPE_TEST

   

OWR_ERROR_TYPE_PROCESSING_ERROR

   

OWR_STATS_TYPE_TEST

   

OWR_STATS_TYPE_SCHEDULE

   

OWR_STATS_TYPE_SEND_PIPELINE_ADDED

   

OWR_STATS_TYPE_SEND_PIPELINE_REMOVED

   

OWR_EVENT_TYPE_TEST

   

OWR_EVENT_TYPE_RENDERER_STARTED

   

OWR_EVENT_TYPE_RENDERER_STOPPED

   

OWR_EVENT_TYPE_LOCAL_SOURCE_STARTED

   

OWR_EVENT_TYPE_LOCAL_SOURCE_STOPPED

   

Property Details

The “message-type-mask” property

  “message-type-mask”        OwrMessageTypes

The message types that the bus should forward, other message types will be discarded (default: forward all messages).

Flags: Read / Write

Default value: Error | State | Event