Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterAudioOutServiceServer(s grpc.ServiceRegistrar, srv AudioOutServiceServer)
- type AudioOutServiceClient
- type AudioOutServiceServer
- type UnimplementedAudioOutServiceServer
- func (UnimplementedAudioOutServiceServer) DoCommand(context.Context, *v11.DoCommandRequest) (*v11.DoCommandResponse, error)
- func (UnimplementedAudioOutServiceServer) GetGeometries(context.Context, *v11.GetGeometriesRequest) (*v11.GetGeometriesResponse, error)
- func (UnimplementedAudioOutServiceServer) GetProperties(context.Context, *v11.GetPropertiesRequest) (*v11.GetPropertiesResponse, error)
- func (UnimplementedAudioOutServiceServer) Play(context.Context, *v1.PlayRequest) (*v1.PlayResponse, error)
- type UnsafeAudioOutServiceServer
Constants ¶
const ( AudioOutService_Play_FullMethodName = "/viam.component.audioout.v1.AudioOutService/Play" AudioOutService_GetProperties_FullMethodName = "/viam.component.audioout.v1.AudioOutService/GetProperties" AudioOutService_DoCommand_FullMethodName = "/viam.component.audioout.v1.AudioOutService/DoCommand" AudioOutService_GetGeometries_FullMethodName = "/viam.component.audioout.v1.AudioOutService/GetGeometries" )
Variables ¶
var AudioOutService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "viam.component.audioout.v1.AudioOutService", HandlerType: (*AudioOutServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Play", Handler: _AudioOutService_Play_Handler, }, { MethodName: "GetProperties", Handler: _AudioOutService_GetProperties_Handler, }, { MethodName: "DoCommand", Handler: _AudioOutService_DoCommand_Handler, }, { MethodName: "GetGeometries", Handler: _AudioOutService_GetGeometries_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "component/audioout/v1/audioout.proto", }
AudioOutService_ServiceDesc is the grpc.ServiceDesc for AudioOutService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterAudioOutServiceServer ¶
func RegisterAudioOutServiceServer(s grpc.ServiceRegistrar, srv AudioOutServiceServer)
Types ¶
type AudioOutServiceClient ¶
type AudioOutServiceClient interface {
// Play plays audio from the audioout component.
Play(ctx context.Context, in *v1.PlayRequest, opts ...grpc.CallOption) (*v1.PlayResponse, error)
// GetProperties returns the properties of the audioout.
GetProperties(ctx context.Context, in *v11.GetPropertiesRequest, opts ...grpc.CallOption) (*v11.GetPropertiesResponse, error)
// DoCommand sends/receives arbitrary commands
DoCommand(ctx context.Context, in *v11.DoCommandRequest, opts ...grpc.CallOption) (*v11.DoCommandResponse, error)
// GetGeometries returns the geometries of the component in their current configuration
GetGeometries(ctx context.Context, in *v11.GetGeometriesRequest, opts ...grpc.CallOption) (*v11.GetGeometriesResponse, error)
}
AudioOutServiceClient is the client API for AudioOutService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
An AudioOutService services all audio outputs associated with a robot
func NewAudioOutServiceClient ¶
func NewAudioOutServiceClient(cc grpc.ClientConnInterface) AudioOutServiceClient
type AudioOutServiceServer ¶
type AudioOutServiceServer interface {
// Play plays audio from the audioout component.
Play(context.Context, *v1.PlayRequest) (*v1.PlayResponse, error)
// GetProperties returns the properties of the audioout.
GetProperties(context.Context, *v11.GetPropertiesRequest) (*v11.GetPropertiesResponse, error)
// DoCommand sends/receives arbitrary commands
DoCommand(context.Context, *v11.DoCommandRequest) (*v11.DoCommandResponse, error)
// GetGeometries returns the geometries of the component in their current configuration
GetGeometries(context.Context, *v11.GetGeometriesRequest) (*v11.GetGeometriesResponse, error)
}
AudioOutServiceServer is the server API for AudioOutService service. All implementations should embed UnimplementedAudioOutServiceServer for forward compatibility.
An AudioOutService services all audio outputs associated with a robot
type UnimplementedAudioOutServiceServer ¶
type UnimplementedAudioOutServiceServer struct{}
UnimplementedAudioOutServiceServer should be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedAudioOutServiceServer) DoCommand ¶
func (UnimplementedAudioOutServiceServer) DoCommand(context.Context, *v11.DoCommandRequest) (*v11.DoCommandResponse, error)
func (UnimplementedAudioOutServiceServer) GetGeometries ¶
func (UnimplementedAudioOutServiceServer) GetGeometries(context.Context, *v11.GetGeometriesRequest) (*v11.GetGeometriesResponse, error)
func (UnimplementedAudioOutServiceServer) GetProperties ¶
func (UnimplementedAudioOutServiceServer) GetProperties(context.Context, *v11.GetPropertiesRequest) (*v11.GetPropertiesResponse, error)
func (UnimplementedAudioOutServiceServer) Play ¶
func (UnimplementedAudioOutServiceServer) Play(context.Context, *v1.PlayRequest) (*v1.PlayResponse, error)
type UnsafeAudioOutServiceServer ¶
type UnsafeAudioOutServiceServer interface {
// contains filtered or unexported methods
}
UnsafeAudioOutServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AudioOutServiceServer will result in compilation errors.
Source Files
¶
- audioout_grpc.pb.go