Documentation
¶
Overview ¶
Package audioout_api is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterAudiooutServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterAudiooutServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client AudiooutServiceClient) error
- func RegisterAudiooutServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterAudiooutServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server AudiooutServiceServer) error
- func RegisterAudiooutServiceServer(s grpc.ServiceRegistrar, srv AudiooutServiceServer)
- type AudiooutServiceClient
- type AudiooutServiceServer
- type PlayRequest
- func (*PlayRequest) Descriptor() ([]byte, []int)deprecated
- func (x *PlayRequest) GetBlock() bool
- func (x *PlayRequest) GetFadeinMs() int32
- func (x *PlayRequest) GetFilePath() string
- func (x *PlayRequest) GetLoopCount() int32
- func (x *PlayRequest) GetMaxtimeMs() int32
- func (x *PlayRequest) GetName() string
- func (*PlayRequest) ProtoMessage()
- func (x *PlayRequest) ProtoReflect() protoreflect.Message
- func (x *PlayRequest) Reset()
- func (x *PlayRequest) String() string
- type PlayResponse
- type StopRequest
- type StopResponse
- type UnimplementedAudiooutServiceServer
- type UnsafeAudiooutServiceServer
Constants ¶
const ( AudiooutService_Play_FullMethodName = "/viamlabs.service.audioout.v1.AudiooutService/Play" AudiooutService_Stop_FullMethodName = "/viamlabs.service.audioout.v1.AudiooutService/Stop" )
Variables ¶
var AudiooutService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "viamlabs.service.audioout.v1.AudiooutService", HandlerType: (*AudiooutServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Play", Handler: _AudiooutService_Play_Handler, }, { MethodName: "Stop", Handler: _AudiooutService_Stop_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "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)
var File_audioout_proto protoreflect.FileDescriptor
Functions ¶
func RegisterAudiooutServiceHandler ¶
func RegisterAudiooutServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterAudiooutServiceHandler registers the http handlers for service AudiooutService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterAudiooutServiceHandlerClient ¶
func RegisterAudiooutServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client AudiooutServiceClient) error
RegisterAudiooutServiceHandlerClient registers the http handlers for service AudiooutService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "AudiooutServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "AudiooutServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "AudiooutServiceClient" to call the correct interceptors.
func RegisterAudiooutServiceHandlerFromEndpoint ¶
func RegisterAudiooutServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterAudiooutServiceHandlerFromEndpoint is same as RegisterAudiooutServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterAudiooutServiceHandlerServer ¶
func RegisterAudiooutServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server AudiooutServiceServer) error
RegisterAudiooutServiceHandlerServer registers the http handlers for service AudiooutService to "mux". UnaryRPC :call AudiooutServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterAudiooutServiceHandlerFromEndpoint instead.
func RegisterAudiooutServiceServer ¶
func RegisterAudiooutServiceServer(s grpc.ServiceRegistrar, srv AudiooutServiceServer)
Types ¶
type AudiooutServiceClient ¶
type AudiooutServiceClient interface { Play(ctx context.Context, in *PlayRequest, opts ...grpc.CallOption) (*PlayResponse, error) Stop(ctx context.Context, in *StopRequest, opts ...grpc.CallOption) (*StopResponse, 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.
func NewAudiooutServiceClient ¶
func NewAudiooutServiceClient(cc grpc.ClientConnInterface) AudiooutServiceClient
type AudiooutServiceServer ¶
type AudiooutServiceServer interface { Play(context.Context, *PlayRequest) (*PlayResponse, error) Stop(context.Context, *StopRequest) (*StopResponse, error) // contains filtered or unexported methods }
AudiooutServiceServer is the server API for AudiooutService service. All implementations must embed UnimplementedAudiooutServiceServer for forward compatibility
type PlayRequest ¶
type PlayRequest struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` FilePath string `protobuf:"bytes,2,opt,name=file_path,json=filePath,proto3" json:"file_path,omitempty"` LoopCount int32 `protobuf:"varint,3,opt,name=loop_count,json=loopCount,proto3" json:"loop_count,omitempty"` MaxtimeMs int32 `protobuf:"varint,4,opt,name=maxtime_ms,json=maxtimeMs,proto3" json:"maxtime_ms,omitempty"` FadeinMs int32 `protobuf:"varint,5,opt,name=fadein_ms,json=fadeinMs,proto3" json:"fadein_ms,omitempty"` Block bool `protobuf:"varint,6,opt,name=block,proto3" json:"block,omitempty"` // contains filtered or unexported fields }
func (*PlayRequest) Descriptor
deprecated
func (*PlayRequest) Descriptor() ([]byte, []int)
Deprecated: Use PlayRequest.ProtoReflect.Descriptor instead.
func (*PlayRequest) GetBlock ¶
func (x *PlayRequest) GetBlock() bool
func (*PlayRequest) GetFadeinMs ¶
func (x *PlayRequest) GetFadeinMs() int32
func (*PlayRequest) GetFilePath ¶
func (x *PlayRequest) GetFilePath() string
func (*PlayRequest) GetLoopCount ¶
func (x *PlayRequest) GetLoopCount() int32
func (*PlayRequest) GetMaxtimeMs ¶
func (x *PlayRequest) GetMaxtimeMs() int32
func (*PlayRequest) GetName ¶
func (x *PlayRequest) GetName() string
func (*PlayRequest) ProtoMessage ¶
func (*PlayRequest) ProtoMessage()
func (*PlayRequest) ProtoReflect ¶
func (x *PlayRequest) ProtoReflect() protoreflect.Message
func (*PlayRequest) Reset ¶
func (x *PlayRequest) Reset()
func (*PlayRequest) String ¶
func (x *PlayRequest) String() string
type PlayResponse ¶
type PlayResponse struct { Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"` // contains filtered or unexported fields }
func (*PlayResponse) Descriptor
deprecated
func (*PlayResponse) Descriptor() ([]byte, []int)
Deprecated: Use PlayResponse.ProtoReflect.Descriptor instead.
func (*PlayResponse) GetText ¶
func (x *PlayResponse) GetText() string
func (*PlayResponse) ProtoMessage ¶
func (*PlayResponse) ProtoMessage()
func (*PlayResponse) ProtoReflect ¶
func (x *PlayResponse) ProtoReflect() protoreflect.Message
func (*PlayResponse) Reset ¶
func (x *PlayResponse) Reset()
func (*PlayResponse) String ¶
func (x *PlayResponse) String() string
type StopRequest ¶
type StopRequest struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*StopRequest) Descriptor
deprecated
func (*StopRequest) Descriptor() ([]byte, []int)
Deprecated: Use StopRequest.ProtoReflect.Descriptor instead.
func (*StopRequest) GetName ¶
func (x *StopRequest) GetName() string
func (*StopRequest) ProtoMessage ¶
func (*StopRequest) ProtoMessage()
func (*StopRequest) ProtoReflect ¶
func (x *StopRequest) ProtoReflect() protoreflect.Message
func (*StopRequest) Reset ¶
func (x *StopRequest) Reset()
func (*StopRequest) String ¶
func (x *StopRequest) String() string
type StopResponse ¶
type StopResponse struct { Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"` // contains filtered or unexported fields }
func (*StopResponse) Descriptor
deprecated
func (*StopResponse) Descriptor() ([]byte, []int)
Deprecated: Use StopResponse.ProtoReflect.Descriptor instead.
func (*StopResponse) GetText ¶
func (x *StopResponse) GetText() string
func (*StopResponse) ProtoMessage ¶
func (*StopResponse) ProtoMessage()
func (*StopResponse) ProtoReflect ¶
func (x *StopResponse) ProtoReflect() protoreflect.Message
func (*StopResponse) Reset ¶
func (x *StopResponse) Reset()
func (*StopResponse) String ¶
func (x *StopResponse) String() string
type UnimplementedAudiooutServiceServer ¶
type UnimplementedAudiooutServiceServer struct { }
UnimplementedAudiooutServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedAudiooutServiceServer) Play ¶
func (UnimplementedAudiooutServiceServer) Play(context.Context, *PlayRequest) (*PlayResponse, error)
func (UnimplementedAudiooutServiceServer) Stop ¶
func (UnimplementedAudiooutServiceServer) Stop(context.Context, *StopRequest) (*StopResponse, 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.