This module defines channels to easily log messages conforming to well-known Foxglove schemas.

See the foxglove.schemas module for available definitions.

class foxglove.channels.ArrowPrimitiveChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.ArrowPrimitive messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.ArrowPrimitive message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.CameraCalibrationChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.CameraCalibration messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.CameraCalibration message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.CircleAnnotationChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.CircleAnnotation messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.CircleAnnotation message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.ColorChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.Color messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.Color message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.CompressedImageChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.CompressedImage messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.CompressedImage message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.CompressedVideoChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.CompressedVideo messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.CompressedVideo message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.CubePrimitiveChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.CubePrimitive messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.CubePrimitive message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.CylinderPrimitiveChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.CylinderPrimitive messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.CylinderPrimitive message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.FrameTransformChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.FrameTransform messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.FrameTransform message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.FrameTransformsChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.FrameTransforms messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.FrameTransforms message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.GeoJsonChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.GeoJson messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.GeoJson message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.GridChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.Grid messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.Grid message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.ImageAnnotationsChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.ImageAnnotations messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.ImageAnnotations message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.KeyValuePairChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.KeyValuePair messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.KeyValuePair message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.LaserScanChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.LaserScan messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.LaserScan message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.LinePrimitiveChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.LinePrimitive messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.LinePrimitive message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.LocationFixChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.LocationFix messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.LocationFix message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.LocationFixesChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.LocationFixes messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.LocationFixes message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.LogChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.Log messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.Log message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.ModelPrimitiveChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.ModelPrimitive messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.ModelPrimitive message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.PackedElementFieldChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.PackedElementField messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.PackedElementField message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.Point2Channel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.Point2 messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.Point2 message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.Point3Channel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.Point3 messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.Point3 message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.PointCloudChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.PointCloud messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.PointCloud message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.PointsAnnotationChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.PointsAnnotation messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.PointsAnnotation message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.PoseChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.Pose messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.Pose message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.PoseInFrameChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.PoseInFrame messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.PoseInFrame message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.PosesInFrameChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.PosesInFrame messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.PosesInFrame message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.QuaternionChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.Quaternion messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.Quaternion message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.RawAudioChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.RawAudio messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.RawAudio message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.RawImageChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.RawImage messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.RawImage message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.SceneEntityChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.SceneEntity messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.SceneEntity message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.SceneEntityDeletionChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.SceneEntityDeletion messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.SceneEntityDeletion message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.SceneUpdateChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.SceneUpdate messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.SceneUpdate message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.SpherePrimitiveChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.SpherePrimitive messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.SpherePrimitive message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.TextAnnotationChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.TextAnnotation messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.TextAnnotation message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.TextPrimitiveChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.TextPrimitive messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.TextPrimitive message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.TriangleListPrimitiveChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.TriangleListPrimitive messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.TriangleListPrimitive message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.Vector2Channel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.Vector2 messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.Vector2 message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.Vector3Channel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.Vector3 messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.Vector3 message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.

class foxglove.channels.VoxelGridChannel(topic, *, metadata=None, context=None)

A channel for logging foxglove.schemas.VoxelGrid messages.

close()

Close the channel.

You can use this to explicitly unadvertise the channel to sinks that subscribe to channels dynamically, such as the foxglove.websocket.WebSocketServer.

Attempts to log on a closed channel will elicit a throttled warning message.

has_sinks()

Returns true if at least one sink is subscribed to this channel.

id()

The unique ID of the channel.

log(msg, *, log_time=None, sink_id=None)

Log a foxglove.schemas.VoxelGrid message to the channel.

Parameters:

• msg – The message to log.

• log_time (default: None) – The log time is the time, as nanoseconds from the unix epoch, that the message was recorded. Usually this is the time log() is called. If omitted, the current time is used.

• sink_id (default: None) – The ID of the sink to log to. If omitted, the message is logged to all sinks.

message_encoding

The message encoding for the channel.

metadata()

Returns a copy of the channel’s metadata.

Note that changes made to the returned dictionary will not be applied to the channel’s metadata.

schema()

Returns a copy of the channel’s schema.

Note that changes made to the returned object will not be applied to the channel’s schema.

schema_name()

The name of the schema for the channel.

topic()

The topic name of the channel.