recording

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

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

Documentation

Overview

Package recording provides recording types for OmniMeet.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Layout

type Layout string

Layout specifies the video layout for composite recordings.

const (
	LayoutGrid       Layout = "grid"
	LayoutSpeaker    Layout = "speaker"
	LayoutSideBySide Layout = "side_by_side"
)

type Options

type Options struct {
	// Format specifies the output format (e.g., "mp4", "webm").
	Format string `json:"format,omitempty"`

	// AudioOnly records only audio.
	AudioOnly bool `json:"audio_only,omitempty"`

	// Layout specifies the video layout for composite recordings.
	Layout Layout `json:"layout,omitempty"`

	// OutputURL specifies where to upload the recording.
	OutputURL string `json:"output_url,omitempty"`

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

	// Extensions contains provider-specific configuration.
	Extensions map[string]any `json:"extensions,omitempty"`
}

Options contains options for starting a recording.

type Recording

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

	// MeetingID is the ID of the meeting being recorded.
	MeetingID string `json:"meeting_id"`

	// Status is the current status of the recording.
	Status Status `json:"status"`

	// StartedAt is when the recording started.
	StartedAt time.Time `json:"started_at"`

	// EndedAt is when the recording ended (nil if still recording).
	EndedAt *time.Time `json:"ended_at,omitempty"`

	// Duration is the duration of the recording.
	Duration time.Duration `json:"duration,omitempty"`

	// Size is the size of the recording in bytes.
	Size int64 `json:"size,omitempty"`

	// URL is the download URL for the recording (if available).
	URL string `json:"url,omitempty"`

	// Format is the recording format (e.g., "mp4", "webm").
	Format string `json:"format,omitempty"`

	// Error contains error details if the recording failed.
	Error string `json:"error,omitempty"`

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

Recording represents a meeting recording.

func (*Recording) IsActive

func (r *Recording) IsActive() bool

IsActive returns true if the recording is still in progress.

type Status

type Status string

Status represents the status of a recording.

const (
	StatusPending    Status = "pending"
	StatusRecording  Status = "recording"
	StatusProcessing Status = "processing"
	StatusCompleted  Status = "completed"
	StatusFailed     Status = "failed"
)

Jump to

Keyboard shortcuts

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