track

package

v0.1.0 Latest Latest Go to latest Published: Jul 5, 2026 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/plexusone/omnimeet-core

Links

Open Source Insights

Documentation ¶

Overview ¶

Package track provides the Track type and related types for OmniMeet.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Kind ¶

type Kind string

Kind represents the type of media track.

const (
	// KindAudio represents an audio track (microphone, etc.).
	KindAudio Kind = "audio"
	// KindVideo represents a video track (camera, etc.).
	KindVideo Kind = "video"
	// KindScreenShare represents a screen share track.
	KindScreenShare Kind = "screen_share"
	// KindScreenShareAudio represents audio from a screen share.
	KindScreenShareAudio Kind = "screen_share_audio"
	// KindData represents a data channel.
	KindData Kind = "data"
)

type PublishRequest ¶

type PublishRequest struct {
	// Kind is the type of track to publish.
	Kind Kind `json:"kind"`

	// Source is where the track originates.
	Source Source `json:"source"`

	// Name is an optional name for the track.
	Name string `json:"name,omitempty"`

	// Simulcast enables simulcast for video tracks.
	Simulcast bool `json:"simulcast,omitempty"`

	// Width is the video width (for video tracks).
	Width int `json:"width,omitempty"`

	// Height is the video height (for video tracks).
	Height int `json:"height,omitempty"`

	// Metadata contains arbitrary key-value pairs.
	Metadata map[string]string `json:"metadata,omitempty"`
}

PublishRequest contains options for publishing a track.

type Source ¶

type Source string

Source represents the source of a track.

const (
	// SourceMicrophone indicates audio from a microphone.
	SourceMicrophone Source = "microphone"
	// SourceCamera indicates video from a camera.
	SourceCamera Source = "camera"
	// SourceScreen indicates content from screen sharing.
	SourceScreen Source = "screen"
	// SourceApplication indicates content from a specific application.
	SourceApplication Source = "application"
	// SourceUnknown indicates an unknown source.
	SourceUnknown Source = "unknown"
)

type SubscribeOptions ¶

type SubscribeOptions struct {
	// Quality specifies the desired quality for video tracks.
	Quality VideoQuality `json:"quality,omitempty"`
}

SubscribeOptions contains options for subscribing to a track.

type Track ¶

type Track struct {
	// ID is the unique identifier for this track.
	ID string `json:"id"`

	// ParticipantID is the ID of the participant who published this track.
	ParticipantID string `json:"participant_id"`

	// Kind indicates the type of track.
	Kind Kind `json:"kind"`

	// Source indicates where the track originated.
	Source Source `json:"source"`

	// Name is an optional name for the track.
	Name string `json:"name,omitempty"`

	// Muted indicates whether the track is currently muted.
	Muted bool `json:"muted"`

	// PublishedAt is when the track was published.
	PublishedAt time.Time `json:"published_at"`

	// UnpublishedAt is when the track was unpublished (nil if still active).
	UnpublishedAt *time.Time `json:"unpublished_at,omitempty"`

	// Width is the video width in pixels (0 for non-video tracks).
	Width int `json:"width,omitempty"`

	// Height is the video height in pixels (0 for non-video tracks).
	Height int `json:"height,omitempty"`

	// Simulcast indicates whether simulcast is enabled for this track.
	Simulcast bool `json:"simulcast,omitempty"`

	// Metadata contains arbitrary key-value pairs.
	Metadata map[string]string `json:"metadata,omitempty"`
}

Track represents a media stream published by a participant.

Tracks can be audio, video, screen share, or data channels. Each track has a kind, source, and mute state.

func (*Track) IsActive ¶

func (t *Track) IsActive() bool

IsActive returns true if the track is still published.

func (*Track) IsAudio ¶

func (t *Track) IsAudio() bool

IsAudio returns true if this is an audio track.

func (*Track) IsVideo ¶

func (t *Track) IsVideo() bool

IsVideo returns true if this is a video track.

type VideoQuality ¶

type VideoQuality string

VideoQuality represents the quality level for video tracks.

const (
	VideoQualityLow    VideoQuality = "low"
	VideoQualityMedium VideoQuality = "medium"
	VideoQualityHigh   VideoQuality = "high"
	VideoQualityOff    VideoQuality = "off"
)

Source Files ¶

View all Source files

track.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL