messages

package
v1.0.0-beta1 Latest Latest
Warning

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

Go to latest
Published: Oct 9, 2024 License: MIT Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	PluginType_name = map[int32]string{
		0: "Unknown",
		1: "IN",
		2: "OUT",
		3: "INOUT",
	}
	PluginType_value = map[string]int32{
		"Unknown": 0,
		"IN":      1,
		"OUT":     2,
		"INOUT":   3,
	}
)

Enum value maps for PluginType.

View Source
var File_plugin_v1_messages_export_proto protoreflect.FileDescriptor
View Source
var File_plugin_v1_messages_info_proto protoreflect.FileDescriptor
View Source
var File_plugin_v1_messages_parse_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ExportRequest

type ExportRequest struct {

	// The tunes to export.
	// In multi tune file formats like bww, this will contain all the tunes in the file.
	// For single tune file formats like MusicXML, this must contain a single tune
	// if multiple tunes are provided, an error will be returned.
	ExportTunes []*tune.Tune `protobuf:"bytes,1,rep,name=export_tunes,json=exportTunes,proto3" json:"export_tunes,omitempty"`
	// contains filtered or unexported fields
}

func (*ExportRequest) Descriptor deprecated

func (*ExportRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExportRequest.ProtoReflect.Descriptor instead.

func (*ExportRequest) GetExportTunes

func (x *ExportRequest) GetExportTunes() []*tune.Tune

func (*ExportRequest) ProtoMessage

func (*ExportRequest) ProtoMessage()

func (*ExportRequest) ProtoReflect

func (x *ExportRequest) ProtoReflect() protoreflect.Message

func (*ExportRequest) Reset

func (x *ExportRequest) Reset()

func (*ExportRequest) String

func (x *ExportRequest) String() string

type ExportResponse

type ExportResponse struct {

	// In case it should be exported to data, this will contain the raw data.
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ExportResponse) Descriptor deprecated

func (*ExportResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportResponse.ProtoReflect.Descriptor instead.

func (*ExportResponse) GetData

func (x *ExportResponse) GetData() []byte

func (*ExportResponse) ProtoMessage

func (*ExportResponse) ProtoMessage()

func (*ExportResponse) ProtoReflect

func (x *ExportResponse) ProtoReflect() protoreflect.Message

func (*ExportResponse) Reset

func (x *ExportResponse) Reset()

func (*ExportResponse) String

func (x *ExportResponse) String() string

type ExportToFileRequest

type ExportToFileRequest struct {

	// The tunes to export.
	// In multi tune file formats like bww, this will contain all the tunes in the file.
	// For single tune file formats like MusicXML, this must contain a single tune
	// if multiple tunes are provided, an error will be returned.
	ExportTunes []*tune.Tune `protobuf:"bytes,1,rep,name=export_tunes,json=exportTunes,proto3" json:"export_tunes,omitempty"`
	// The path to the file to export the tunes to.
	// The path must not be empty.
	FilePath string `protobuf:"bytes,2,opt,name=file_path,json=filePath,proto3" json:"file_path,omitempty"`
	// contains filtered or unexported fields
}

func (*ExportToFileRequest) Descriptor deprecated

func (*ExportToFileRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExportToFileRequest.ProtoReflect.Descriptor instead.

func (*ExportToFileRequest) GetExportTunes

func (x *ExportToFileRequest) GetExportTunes() []*tune.Tune

func (*ExportToFileRequest) GetFilePath

func (x *ExportToFileRequest) GetFilePath() string

func (*ExportToFileRequest) ProtoMessage

func (*ExportToFileRequest) ProtoMessage()

func (*ExportToFileRequest) ProtoReflect

func (x *ExportToFileRequest) ProtoReflect() protoreflect.Message

func (*ExportToFileRequest) Reset

func (x *ExportToFileRequest) Reset()

func (*ExportToFileRequest) String

func (x *ExportToFileRequest) String() string

type ExportToFileResponse

type ExportToFileResponse struct {
	// contains filtered or unexported fields
}

func (*ExportToFileResponse) Descriptor deprecated

func (*ExportToFileResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportToFileResponse.ProtoReflect.Descriptor instead.

func (*ExportToFileResponse) ProtoMessage

func (*ExportToFileResponse) ProtoMessage()

func (*ExportToFileResponse) ProtoReflect

func (x *ExportToFileResponse) ProtoReflect() protoreflect.Message

func (*ExportToFileResponse) Reset

func (x *ExportToFileResponse) Reset()

func (*ExportToFileResponse) String

func (x *ExportToFileResponse) String() string

type ParseFromFileRequest

type ParseFromFileRequest struct {
	FilePath string `protobuf:"bytes,1,opt,name=file_path,json=filePath,proto3" json:"file_path,omitempty"` // Path to local file
	// contains filtered or unexported fields
}

func (*ParseFromFileRequest) Descriptor deprecated

func (*ParseFromFileRequest) Descriptor() ([]byte, []int)

Deprecated: Use ParseFromFileRequest.ProtoReflect.Descriptor instead.

func (*ParseFromFileRequest) GetFilePath

func (x *ParseFromFileRequest) GetFilePath() string

func (*ParseFromFileRequest) ProtoMessage

func (*ParseFromFileRequest) ProtoMessage()

func (*ParseFromFileRequest) ProtoReflect

func (x *ParseFromFileRequest) ProtoReflect() protoreflect.Message

func (*ParseFromFileRequest) Reset

func (x *ParseFromFileRequest) Reset()

func (*ParseFromFileRequest) String

func (x *ParseFromFileRequest) String() string

type ParseFromFileResponse

type ParseFromFileResponse struct {

	// The tunes that could be parsed.
	// In multi tune file formats like bww, this will contain all the tunes in the file.
	// For single tune file formats like MusicXML, this will contain a single tune.
	Tunes []*ParsedTune `protobuf:"bytes,1,rep,name=tunes,proto3" json:"tunes,omitempty"`
	// contains filtered or unexported fields
}

func (*ParseFromFileResponse) Descriptor deprecated

func (*ParseFromFileResponse) Descriptor() ([]byte, []int)

Deprecated: Use ParseFromFileResponse.ProtoReflect.Descriptor instead.

func (*ParseFromFileResponse) GetTunes

func (x *ParseFromFileResponse) GetTunes() []*ParsedTune

func (*ParseFromFileResponse) ProtoMessage

func (*ParseFromFileResponse) ProtoMessage()

func (*ParseFromFileResponse) ProtoReflect

func (x *ParseFromFileResponse) ProtoReflect() protoreflect.Message

func (*ParseFromFileResponse) Reset

func (x *ParseFromFileResponse) Reset()

func (*ParseFromFileResponse) String

func (x *ParseFromFileResponse) String() string

type ParseRequest

type ParseRequest struct {
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"` // Data to parse into tunes
	// contains filtered or unexported fields
}

func (*ParseRequest) Descriptor deprecated

func (*ParseRequest) Descriptor() ([]byte, []int)

Deprecated: Use ParseRequest.ProtoReflect.Descriptor instead.

func (*ParseRequest) GetData

func (x *ParseRequest) GetData() []byte

func (*ParseRequest) ProtoMessage

func (*ParseRequest) ProtoMessage()

func (*ParseRequest) ProtoReflect

func (x *ParseRequest) ProtoReflect() protoreflect.Message

func (*ParseRequest) Reset

func (x *ParseRequest) Reset()

func (*ParseRequest) String

func (x *ParseRequest) String() string

type ParseResponse

type ParseResponse struct {

	// The tunes that could be parsed.
	// In multi tune file formats like bww, this will contain all the tunes in the file.
	// For single tune file formats like MusicXML, this will contain a single tune.
	Tunes []*ParsedTune `protobuf:"bytes,1,rep,name=tunes,proto3" json:"tunes,omitempty"`
	// contains filtered or unexported fields
}

func (*ParseResponse) Descriptor deprecated

func (*ParseResponse) Descriptor() ([]byte, []int)

Deprecated: Use ParseResponse.ProtoReflect.Descriptor instead.

func (*ParseResponse) GetTunes

func (x *ParseResponse) GetTunes() []*ParsedTune

func (*ParseResponse) ProtoMessage

func (*ParseResponse) ProtoMessage()

func (*ParseResponse) ProtoReflect

func (x *ParseResponse) ProtoReflect() protoreflect.Message

func (*ParseResponse) Reset

func (x *ParseResponse) Reset()

func (*ParseResponse) String

func (x *ParseResponse) String() string

type ParsedTune

type ParsedTune struct {

	// The tune that was imported.
	Tune *tune.Tune `protobuf:"bytes,1,opt,name=tune,proto3" json:"tune,omitempty"`
	// The data with which the tune can be restored to a file.
	// In multi tune file formats like bww, this data will represent a single tune.
	// For single tune file formats like MusicXML, this data will always be empty.
	TuneFileData []byte `protobuf:"bytes,2,opt,name=tune_file_data,json=tuneFileData,proto3" json:"tune_file_data,omitempty"`
	// contains filtered or unexported fields
}

func (*ParsedTune) Descriptor deprecated

func (*ParsedTune) Descriptor() ([]byte, []int)

Deprecated: Use ParsedTune.ProtoReflect.Descriptor instead.

func (*ParsedTune) GetTune

func (x *ParsedTune) GetTune() *tune.Tune

func (*ParsedTune) GetTuneFileData

func (x *ParsedTune) GetTuneFileData() []byte

func (*ParsedTune) ProtoMessage

func (*ParsedTune) ProtoMessage()

func (*ParsedTune) ProtoReflect

func (x *ParsedTune) ProtoReflect() protoreflect.Message

func (*ParsedTune) Reset

func (x *ParsedTune) Reset()

func (*ParsedTune) String

func (x *ParsedTune) String() string

type PluginInfoRequest

type PluginInfoRequest struct {
	// contains filtered or unexported fields
}

func (*PluginInfoRequest) Descriptor deprecated

func (*PluginInfoRequest) Descriptor() ([]byte, []int)

Deprecated: Use PluginInfoRequest.ProtoReflect.Descriptor instead.

func (*PluginInfoRequest) ProtoMessage

func (*PluginInfoRequest) ProtoMessage()

func (*PluginInfoRequest) ProtoReflect

func (x *PluginInfoRequest) ProtoReflect() protoreflect.Message

func (*PluginInfoRequest) Reset

func (x *PluginInfoRequest) Reset()

func (*PluginInfoRequest) String

func (x *PluginInfoRequest) String() string

type PluginInfoResponse

type PluginInfoResponse struct {
	Name        string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`               // Name of the plugin
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` // Description of the plugin
	// Type of the plugin (IN, OUT, INOUT)
	Type PluginType `protobuf:"varint,3,opt,name=type,proto3,enum=plugin.v1.messages.PluginType" json:"type,omitempty"`
	// The file format that the plugin can parse and/or write
	FileFormat fileformat.Format `protobuf:"varint,4,opt,name=file_format,json=fileFormat,proto3,enum=plugin.v1.fileformat.Format" json:"file_format,omitempty"`
	// File extension names that the plugin can parse and/or write (e.g. ".bww", ".ly")
	FileExtensions []string `protobuf:"bytes,5,rep,name=file_extensions,json=fileExtensions,proto3" json:"file_extensions,omitempty"`
	// contains filtered or unexported fields
}

func (*PluginInfoResponse) Descriptor deprecated

func (*PluginInfoResponse) Descriptor() ([]byte, []int)

Deprecated: Use PluginInfoResponse.ProtoReflect.Descriptor instead.

func (*PluginInfoResponse) GetDescription

func (x *PluginInfoResponse) GetDescription() string

func (*PluginInfoResponse) GetFileExtensions

func (x *PluginInfoResponse) GetFileExtensions() []string

func (*PluginInfoResponse) GetFileFormat

func (x *PluginInfoResponse) GetFileFormat() fileformat.Format

func (*PluginInfoResponse) GetName

func (x *PluginInfoResponse) GetName() string

func (*PluginInfoResponse) GetType

func (x *PluginInfoResponse) GetType() PluginType

func (*PluginInfoResponse) ProtoMessage

func (*PluginInfoResponse) ProtoMessage()

func (*PluginInfoResponse) ProtoReflect

func (x *PluginInfoResponse) ProtoReflect() protoreflect.Message

func (*PluginInfoResponse) Reset

func (x *PluginInfoResponse) Reset()

func (*PluginInfoResponse) String

func (x *PluginInfoResponse) String() string

type PluginType

type PluginType int32
const (
	PluginType_Unknown PluginType = 0
	PluginType_IN      PluginType = 1
	PluginType_OUT     PluginType = 2
	PluginType_INOUT   PluginType = 3
)

func (PluginType) Descriptor

func (PluginType) Descriptor() protoreflect.EnumDescriptor

func (PluginType) Enum

func (x PluginType) Enum() *PluginType

func (PluginType) EnumDescriptor deprecated

func (PluginType) EnumDescriptor() ([]byte, []int)

Deprecated: Use PluginType.Descriptor instead.

func (PluginType) Number

func (x PluginType) Number() protoreflect.EnumNumber

func (PluginType) String

func (x PluginType) String() string

func (PluginType) Type

Jump to

Keyboard shortcuts

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