audioout

Documentation

Overview

Package audioout implements the viam-labs:service:audioout API

Index

• Variables
• func Named(name string) resource.Name
• func NewRPCServiceServer(coll resource.APIResourceCollection[Audioout]) interface{}
• type Audioout
  • func FromRobot(r robot.Robot, name string) (Audioout, error)
  • func NewClientFromConn(conn rpc.ClientConn, remoteName string, name resource.Name, ...) Audioout

Variables

var API = resource.APINamespace("viam-labs").WithServiceType("audioout")

API is the full API definition.

Functions

func Named

func Named(name string) resource.Name

Named is a helper for getting the named Audioout's typed resource name.

func NewRPCServiceServer

func NewRPCServiceServer(coll resource.APIResourceCollection[Audioout]) interface{}

NewRPCServiceServer returns a new RPC server for the Audioout API.

Types

type Audioout

type Audioout interface {
	resource.Resource
	Play(ctx context.Context, file_path string, loop_count, maxtime_ms, fadein_ms int, block bool) error
	Stop(ctx context.Context) error
}

Audioout defines the Go interface for the component (should match the protobuf methods.)

func FromRobot

func FromRobot(r robot.Robot, name string) (Audioout, error)

FromRobot is a helper for getting the named Audioout from the given Robot.

func NewClientFromConn

func NewClientFromConn(conn rpc.ClientConn, remoteName string, name resource.Name, logger golog.Logger) Audioout

NewClientFromConn creates a new Audioout RPC client from an existing connection.