layoutv2

package
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: Apr 18, 2024 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const (
	LayerService_ListLayers_FullMethodName  = "/apis.layout.v2.LayerService/ListLayers"
	LayerService_CreateLayer_FullMethodName = "/apis.layout.v2.LayerService/CreateLayer"
	LayerService_GetLayer_FullMethodName    = "/apis.layout.v2.LayerService/GetLayer"
	LayerService_UpdateLayer_FullMethodName = "/apis.layout.v2.LayerService/UpdateLayer"
	LayerService_DeleteLayer_FullMethodName = "/apis.layout.v2.LayerService/DeleteLayer"
	LayerService_Batch_FullMethodName       = "/apis.layout.v2.LayerService/Batch"
)
View Source
const (
	LayoutService_ListLayouts_FullMethodName  = "/apis.layout.v2.LayoutService/ListLayouts"
	LayoutService_CreateLayout_FullMethodName = "/apis.layout.v2.LayoutService/CreateLayout"
	LayoutService_GetLayout_FullMethodName    = "/apis.layout.v2.LayoutService/GetLayout"
	LayoutService_UpdateLayout_FullMethodName = "/apis.layout.v2.LayoutService/UpdateLayout"
	LayoutService_DeleteLayout_FullMethodName = "/apis.layout.v2.LayoutService/DeleteLayout"
)

Variables

View Source
var (
	LayoutType_name = map[int32]string{
		0: "LAYOUT_TYPE_UNSPECIFIED",
		1: "LAYOUT_TYPE_SCENELESS",
		2: "LAYOUT_TYPE_SCENE",
	}
	LayoutType_value = map[string]int32{
		"LAYOUT_TYPE_UNSPECIFIED": 0,
		"LAYOUT_TYPE_SCENELESS":   1,
		"LAYOUT_TYPE_SCENE":       2,
	}
)

Enum value maps for LayoutType.

View Source
var (
	RequestAnimationMode_name = map[int32]string{
		0: "REQUEST_ANIMATION_MODE_UNSPECIFIED",
		1: "REQUEST_ANIMATION_MODE_PARALLEL",
		2: "REQUEST_ANIMATION_MODE_SERIES",
	}
	RequestAnimationMode_value = map[string]int32{
		"REQUEST_ANIMATION_MODE_UNSPECIFIED": 0,
		"REQUEST_ANIMATION_MODE_PARALLEL":    1,
		"REQUEST_ANIMATION_MODE_SERIES":      2,
	}
)

Enum value maps for RequestAnimationMode.

View Source
var (
	EventSubType_name = map[int32]string{
		0: "EVENT_SUB_TYPE_UNSPECIFIED",
		1: "EVENT_SUB_TYPE_CREATE",
		2: "EVENT_SUB_TYPE_UPDATE",
		3: "EVENT_SUB_TYPE_DELETE",
		4: "EVENT_SUB_TYPE_BATCH",
	}
	EventSubType_value = map[string]int32{
		"EVENT_SUB_TYPE_UNSPECIFIED": 0,
		"EVENT_SUB_TYPE_CREATE":      1,
		"EVENT_SUB_TYPE_UPDATE":      2,
		"EVENT_SUB_TYPE_DELETE":      3,
		"EVENT_SUB_TYPE_BATCH":       4,
	}
)

Enum value maps for EventSubType.

View Source
var (
	EventType_name = map[int32]string{
		0: "EVENT_TYPE_UNSPECIFIED",
		1: "EVENT_TYPE_LAYOUT",
		2: "EVENT_TYPE_LAYER",
	}
	EventType_value = map[string]int32{
		"EVENT_TYPE_UNSPECIFIED": 0,
		"EVENT_TYPE_LAYOUT":      1,
		"EVENT_TYPE_LAYER":       2,
	}
)

Enum value maps for EventType.

View Source
var (
	Transition_TransitionDirection_name = map[int32]string{
		0: "TRANSITION_DIRECTION_UNSPECIFIED",
		1: "TRANSITION_DIRECTION_LEFT",
		2: "TRANSITION_DIRECTION_RIGHT",
		3: "TRANSITION_DIRECTION_UP",
		4: "TRANSITION_DIRECTION_DOWN",
	}
	Transition_TransitionDirection_value = map[string]int32{
		"TRANSITION_DIRECTION_UNSPECIFIED": 0,
		"TRANSITION_DIRECTION_LEFT":        1,
		"TRANSITION_DIRECTION_RIGHT":       2,
		"TRANSITION_DIRECTION_UP":          3,
		"TRANSITION_DIRECTION_DOWN":        4,
	}
)

Enum value maps for Transition_TransitionDirection.

View Source
var (
	Transition_TransitionSwipeType_name = map[int32]string{
		0: "TRANSITION_SWIPE_TYPE_UNSPECIFIED",
		1: "TRANSITION_SWIPE_TYPE_COMBINED",
		2: "TRANSITION_SWIPE_TYPE_SOURCE",
		3: "TRANSITION_SWIPE_TYPE_DESTINATION",
	}
	Transition_TransitionSwipeType_value = map[string]int32{
		"TRANSITION_SWIPE_TYPE_UNSPECIFIED": 0,
		"TRANSITION_SWIPE_TYPE_COMBINED":    1,
		"TRANSITION_SWIPE_TYPE_SOURCE":      2,
		"TRANSITION_SWIPE_TYPE_DESTINATION": 3,
	}
)

Enum value maps for Transition_TransitionSwipeType.

View Source
var File_apis_layout_v2_api_proto protoreflect.FileDescriptor
View Source
var LayerService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "apis.layout.v2.LayerService",
	HandlerType: (*LayerServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListLayers",
			Handler:    _LayerService_ListLayers_Handler,
		},
		{
			MethodName: "CreateLayer",
			Handler:    _LayerService_CreateLayer_Handler,
		},
		{
			MethodName: "GetLayer",
			Handler:    _LayerService_GetLayer_Handler,
		},
		{
			MethodName: "UpdateLayer",
			Handler:    _LayerService_UpdateLayer_Handler,
		},
		{
			MethodName: "DeleteLayer",
			Handler:    _LayerService_DeleteLayer_Handler,
		},
		{
			MethodName: "Batch",
			Handler:    _LayerService_Batch_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "apis/layout/v2/api.proto",
}

LayerService_ServiceDesc is the grpc.ServiceDesc for LayerService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var LayoutService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "apis.layout.v2.LayoutService",
	HandlerType: (*LayoutServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListLayouts",
			Handler:    _LayoutService_ListLayouts_Handler,
		},
		{
			MethodName: "CreateLayout",
			Handler:    _LayoutService_CreateLayout_Handler,
		},
		{
			MethodName: "GetLayout",
			Handler:    _LayoutService_GetLayout_Handler,
		},
		{
			MethodName: "UpdateLayout",
			Handler:    _LayoutService_UpdateLayout_Handler,
		},
		{
			MethodName: "DeleteLayout",
			Handler:    _LayoutService_DeleteLayout_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "apis/layout/v2/api.proto",
}

LayoutService_ServiceDesc is the grpc.ServiceDesc for LayoutService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterLayerServiceServer

func RegisterLayerServiceServer(s grpc.ServiceRegistrar, srv LayerServiceServer)

func RegisterLayoutServiceServer

func RegisterLayoutServiceServer(s grpc.ServiceRegistrar, srv LayoutServiceServer)

Types

type BatchDeleteLayerRequest

type BatchDeleteLayerRequest struct {

	// ID of the layer deleted.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Metadata associated with the deletion of a layer
	RequestMetadata *structpb.Value `protobuf:"bytes,100,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*BatchDeleteLayerRequest) Descriptor deprecated

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

Deprecated: Use BatchDeleteLayerRequest.ProtoReflect.Descriptor instead.

func (*BatchDeleteLayerRequest) GetId

func (x *BatchDeleteLayerRequest) GetId() string

func (*BatchDeleteLayerRequest) GetRequestMetadata

func (x *BatchDeleteLayerRequest) GetRequestMetadata() *structpb.Value

func (*BatchDeleteLayerRequest) ProtoMessage

func (*BatchDeleteLayerRequest) ProtoMessage()

func (*BatchDeleteLayerRequest) ProtoReflect

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

func (*BatchDeleteLayerRequest) Reset

func (x *BatchDeleteLayerRequest) Reset()

func (*BatchDeleteLayerRequest) String

func (x *BatchDeleteLayerRequest) String() string

type BatchLayerRequest

type BatchLayerRequest struct {

	// The layout all requests interact with.
	LayoutId string `protobuf:"bytes,1,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// List of layers to update
	Layers []*BatchLayerRequest_BatchItem `protobuf:"bytes,2,rep,name=layers,proto3" json:"layers,omitempty"`
	// Metadata sent with the request
	RequestMetadata *structpb.Value `protobuf:"bytes,100,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// Order in which layer animations are applied in the batch.
	RequestAnimationMode *RequestAnimationMode `` /* 173-byte string literal not displayed */
	// contains filtered or unexported fields
}

Batch request to modify a layout.

func (*BatchLayerRequest) Descriptor deprecated

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

Deprecated: Use BatchLayerRequest.ProtoReflect.Descriptor instead.

func (*BatchLayerRequest) GetLayers

func (*BatchLayerRequest) GetLayoutId

func (x *BatchLayerRequest) GetLayoutId() string

func (*BatchLayerRequest) GetRequestAnimationMode

func (x *BatchLayerRequest) GetRequestAnimationMode() RequestAnimationMode

func (*BatchLayerRequest) GetRequestMetadata

func (x *BatchLayerRequest) GetRequestMetadata() *structpb.Value

func (*BatchLayerRequest) ProtoMessage

func (*BatchLayerRequest) ProtoMessage()

func (*BatchLayerRequest) ProtoReflect

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

func (*BatchLayerRequest) Reset

func (x *BatchLayerRequest) Reset()

func (*BatchLayerRequest) String

func (x *BatchLayerRequest) String() string

type BatchLayerRequest_BatchItem

type BatchLayerRequest_BatchItem struct {

	// Types that are assignable to Action:
	//
	//	*BatchLayerRequest_BatchItem_Create
	//	*BatchLayerRequest_BatchItem_Update
	//	*BatchLayerRequest_BatchItem_Delete
	Action isBatchLayerRequest_BatchItem_Action `protobuf_oneof:"action"`
	// contains filtered or unexported fields
}

A batch action.

func (*BatchLayerRequest_BatchItem) Descriptor deprecated

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

Deprecated: Use BatchLayerRequest_BatchItem.ProtoReflect.Descriptor instead.

func (*BatchLayerRequest_BatchItem) GetAction

func (m *BatchLayerRequest_BatchItem) GetAction() isBatchLayerRequest_BatchItem_Action

func (*BatchLayerRequest_BatchItem) GetCreate

func (x *BatchLayerRequest_BatchItem) GetCreate() *PartialLayer

func (*BatchLayerRequest_BatchItem) GetDelete

func (*BatchLayerRequest_BatchItem) GetUpdate

func (*BatchLayerRequest_BatchItem) ProtoMessage

func (*BatchLayerRequest_BatchItem) ProtoMessage()

func (*BatchLayerRequest_BatchItem) ProtoReflect

func (*BatchLayerRequest_BatchItem) Reset

func (x *BatchLayerRequest_BatchItem) Reset()

func (*BatchLayerRequest_BatchItem) String

func (x *BatchLayerRequest_BatchItem) String() string

type BatchLayerRequest_BatchItem_Create

type BatchLayerRequest_BatchItem_Create struct {
	// Create a layer
	Create *PartialLayer `protobuf:"bytes,1,opt,name=create,proto3,oneof"`
}

type BatchLayerRequest_BatchItem_Delete

type BatchLayerRequest_BatchItem_Delete struct {
	// Delete a layer
	Delete *BatchDeleteLayerRequest `protobuf:"bytes,3,opt,name=delete,proto3,oneof"`
}

type BatchLayerRequest_BatchItem_Update

type BatchLayerRequest_BatchItem_Update struct {
	// Update a layer
	Update *PartialLayerWithID `protobuf:"bytes,2,opt,name=update,proto3,oneof"`
}

type BatchLayerResponse

type BatchLayerResponse struct {

	// List of responses
	Layers []*BatchLayerResponse_BatchLayerItem `protobuf:"bytes,2,rep,name=layers,proto3" json:"layers,omitempty"`
	// The layout this batch update belongs to.
	LayoutId string `protobuf:"bytes,3,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// Metadata sent with the request
	RequestMetadata *structpb.Value `protobuf:"bytes,100,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// Order in which layer animations are applied in the batch.
	RequestAnimationMode RequestAnimationMode `` /* 167-byte string literal not displayed */
	// contains filtered or unexported fields
}

A batch update for layers within a layout, indicating creation, removal and updates to layers.

func (*BatchLayerResponse) Descriptor deprecated

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

Deprecated: Use BatchLayerResponse.ProtoReflect.Descriptor instead.

func (*BatchLayerResponse) GetLayers

func (*BatchLayerResponse) GetLayoutId

func (x *BatchLayerResponse) GetLayoutId() string

func (*BatchLayerResponse) GetRequestAnimationMode

func (x *BatchLayerResponse) GetRequestAnimationMode() RequestAnimationMode

func (*BatchLayerResponse) GetRequestMetadata

func (x *BatchLayerResponse) GetRequestMetadata() *structpb.Value

func (*BatchLayerResponse) ProtoMessage

func (*BatchLayerResponse) ProtoMessage()

func (*BatchLayerResponse) ProtoReflect

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

func (*BatchLayerResponse) Reset

func (x *BatchLayerResponse) Reset()

func (*BatchLayerResponse) String

func (x *BatchLayerResponse) String() string

type BatchLayerResponse_BatchLayerItem

type BatchLayerResponse_BatchLayerItem struct {

	// Types that are assignable to Action:
	//
	//	*BatchLayerResponse_BatchLayerItem_Create
	//	*BatchLayerResponse_BatchLayerItem_Update
	//	*BatchLayerResponse_BatchLayerItem_Delete
	Action isBatchLayerResponse_BatchLayerItem_Action `protobuf_oneof:"action"`
	// contains filtered or unexported fields
}

Thee result of interacting with that layer.

func (*BatchLayerResponse_BatchLayerItem) Descriptor deprecated

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

Deprecated: Use BatchLayerResponse_BatchLayerItem.ProtoReflect.Descriptor instead.

func (*BatchLayerResponse_BatchLayerItem) GetAction

func (m *BatchLayerResponse_BatchLayerItem) GetAction() isBatchLayerResponse_BatchLayerItem_Action

func (*BatchLayerResponse_BatchLayerItem) GetCreate

func (x *BatchLayerResponse_BatchLayerItem) GetCreate() *Layer

func (*BatchLayerResponse_BatchLayerItem) GetDelete

func (*BatchLayerResponse_BatchLayerItem) GetUpdate

func (x *BatchLayerResponse_BatchLayerItem) GetUpdate() *Layer

func (*BatchLayerResponse_BatchLayerItem) ProtoMessage

func (*BatchLayerResponse_BatchLayerItem) ProtoMessage()

func (*BatchLayerResponse_BatchLayerItem) ProtoReflect

func (*BatchLayerResponse_BatchLayerItem) Reset

func (*BatchLayerResponse_BatchLayerItem) String

type BatchLayerResponse_BatchLayerItem_Create

type BatchLayerResponse_BatchLayerItem_Create struct {
	Create *Layer `protobuf:"bytes,1,opt,name=create,proto3,oneof"`
}

type BatchLayerResponse_BatchLayerItem_Delete

type BatchLayerResponse_BatchLayerItem_Delete struct {
	Delete *DeleteLayerResponse `protobuf:"bytes,3,opt,name=delete,proto3,oneof"`
}

type BatchLayerResponse_BatchLayerItem_Update

type BatchLayerResponse_BatchLayerItem_Update struct {
	Update *Layer `protobuf:"bytes,2,opt,name=update,proto3,oneof"`
}

type CreateLayerRequest

type CreateLayerRequest struct {

	// the id of the Layout
	LayoutId string `protobuf:"bytes,1,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// layer to create - all fields have defaults except type.
	Layer *PartialLayer `protobuf:"bytes,2,opt,name=layer,proto3" json:"layer,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateLayerRequest) Descriptor deprecated

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

Deprecated: Use CreateLayerRequest.ProtoReflect.Descriptor instead.

func (*CreateLayerRequest) GetLayer

func (x *CreateLayerRequest) GetLayer() *PartialLayer

func (*CreateLayerRequest) GetLayoutId

func (x *CreateLayerRequest) GetLayoutId() string

func (*CreateLayerRequest) ProtoMessage

func (*CreateLayerRequest) ProtoMessage()

func (*CreateLayerRequest) ProtoReflect

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

func (*CreateLayerRequest) Reset

func (x *CreateLayerRequest) Reset()

func (*CreateLayerRequest) String

func (x *CreateLayerRequest) String() string

type CreateLayoutRequest

type CreateLayoutRequest struct {

	// layout to create
	Layout *PartialLayout `protobuf:"bytes,2,opt,name=layout,proto3" json:"layout,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateLayoutRequest) Descriptor deprecated

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

Deprecated: Use CreateLayoutRequest.ProtoReflect.Descriptor instead.

func (*CreateLayoutRequest) GetLayout

func (x *CreateLayoutRequest) GetLayout() *PartialLayout

func (*CreateLayoutRequest) ProtoMessage

func (*CreateLayoutRequest) ProtoMessage()

func (*CreateLayoutRequest) ProtoReflect

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

func (*CreateLayoutRequest) Reset

func (x *CreateLayoutRequest) Reset()

func (*CreateLayoutRequest) String

func (x *CreateLayoutRequest) String() string

type DeleteLayerPayload

type DeleteLayerPayload struct {

	// Metadata associated with the deletion of a layer
	RequestMetadata *structpb.Value `protobuf:"bytes,100,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteLayerPayload) Descriptor deprecated

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

Deprecated: Use DeleteLayerPayload.ProtoReflect.Descriptor instead.

func (*DeleteLayerPayload) GetRequestMetadata

func (x *DeleteLayerPayload) GetRequestMetadata() *structpb.Value

func (*DeleteLayerPayload) ProtoMessage

func (*DeleteLayerPayload) ProtoMessage()

func (*DeleteLayerPayload) ProtoReflect

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

func (*DeleteLayerPayload) Reset

func (x *DeleteLayerPayload) Reset()

func (*DeleteLayerPayload) String

func (x *DeleteLayerPayload) String() string

type DeleteLayerRequest

type DeleteLayerRequest struct {

	// the id of the Layout
	LayoutId string `protobuf:"bytes,1,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// the id of the Layer
	LayerId string `protobuf:"bytes,2,opt,name=layer_id,json=layerId,proto3" json:"layer_id,omitempty"`
	// Metadata associated with the deletion of a layer
	Payload *DeleteLayerPayload `protobuf:"bytes,3,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

Request to delete a specific layer.

func (*DeleteLayerRequest) Descriptor deprecated

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

Deprecated: Use DeleteLayerRequest.ProtoReflect.Descriptor instead.

func (*DeleteLayerRequest) GetLayerId

func (x *DeleteLayerRequest) GetLayerId() string

func (*DeleteLayerRequest) GetLayoutId

func (x *DeleteLayerRequest) GetLayoutId() string

func (*DeleteLayerRequest) GetPayload

func (x *DeleteLayerRequest) GetPayload() *DeleteLayerPayload

func (*DeleteLayerRequest) ProtoMessage

func (*DeleteLayerRequest) ProtoMessage()

func (*DeleteLayerRequest) ProtoReflect

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

func (*DeleteLayerRequest) Reset

func (x *DeleteLayerRequest) Reset()

func (*DeleteLayerRequest) String

func (x *DeleteLayerRequest) String() string

type DeleteLayerResponse

type DeleteLayerResponse struct {

	// The layer id that was deleted
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The layout this layer belongs to.
	LayoutId string `protobuf:"bytes,2,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// Optional request metadata sent with the delete request
	RequestMetadata *structpb.Value `protobuf:"bytes,100,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteLayerResponse) Descriptor deprecated

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

Deprecated: Use DeleteLayerResponse.ProtoReflect.Descriptor instead.

func (*DeleteLayerResponse) GetId

func (x *DeleteLayerResponse) GetId() string

func (*DeleteLayerResponse) GetLayoutId

func (x *DeleteLayerResponse) GetLayoutId() string

func (*DeleteLayerResponse) GetRequestMetadata

func (x *DeleteLayerResponse) GetRequestMetadata() *structpb.Value

func (*DeleteLayerResponse) ProtoMessage

func (*DeleteLayerResponse) ProtoMessage()

func (*DeleteLayerResponse) ProtoReflect

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

func (*DeleteLayerResponse) Reset

func (x *DeleteLayerResponse) Reset()

func (*DeleteLayerResponse) String

func (x *DeleteLayerResponse) String() string

type DeleteLayoutPayload

type DeleteLayoutPayload struct {

	// Metadata associated with the deletion of the layout
	RequestMetadata *structpb.Value `protobuf:"bytes,100,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteLayoutPayload) Descriptor deprecated

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

Deprecated: Use DeleteLayoutPayload.ProtoReflect.Descriptor instead.

func (*DeleteLayoutPayload) GetRequestMetadata

func (x *DeleteLayoutPayload) GetRequestMetadata() *structpb.Value

func (*DeleteLayoutPayload) ProtoMessage

func (*DeleteLayoutPayload) ProtoMessage()

func (*DeleteLayoutPayload) ProtoReflect

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

func (*DeleteLayoutPayload) Reset

func (x *DeleteLayoutPayload) Reset()

func (*DeleteLayoutPayload) String

func (x *DeleteLayoutPayload) String() string

type DeleteLayoutRequest

type DeleteLayoutRequest struct {

	// the id of the Layout
	LayoutId string `protobuf:"bytes,1,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// Metadata associated with the deletion of a layout
	Payload *DeleteLayoutPayload `protobuf:"bytes,2,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

Request to delete a specific layout.

func (*DeleteLayoutRequest) Descriptor deprecated

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

Deprecated: Use DeleteLayoutRequest.ProtoReflect.Descriptor instead.

func (*DeleteLayoutRequest) GetLayoutId

func (x *DeleteLayoutRequest) GetLayoutId() string

func (*DeleteLayoutRequest) GetPayload

func (x *DeleteLayoutRequest) GetPayload() *DeleteLayoutPayload

func (*DeleteLayoutRequest) ProtoMessage

func (*DeleteLayoutRequest) ProtoMessage()

func (*DeleteLayoutRequest) ProtoReflect

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

func (*DeleteLayoutRequest) Reset

func (x *DeleteLayoutRequest) Reset()

func (*DeleteLayoutRequest) String

func (x *DeleteLayoutRequest) String() string

type DeleteLayoutResponse

type DeleteLayoutResponse struct {

	// The ID of the layout deleted
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// Metadata associated with the deletion of a layout
	RequestMetadata *structpb.Value `protobuf:"bytes,100,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteLayoutResponse) Descriptor deprecated

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

Deprecated: Use DeleteLayoutResponse.ProtoReflect.Descriptor instead.

func (*DeleteLayoutResponse) GetId

func (x *DeleteLayoutResponse) GetId() string

func (*DeleteLayoutResponse) GetRequestMetadata

func (x *DeleteLayoutResponse) GetRequestMetadata() *structpb.Value

func (*DeleteLayoutResponse) ProtoMessage

func (*DeleteLayoutResponse) ProtoMessage()

func (*DeleteLayoutResponse) ProtoReflect

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

func (*DeleteLayoutResponse) Reset

func (x *DeleteLayoutResponse) Reset()

func (*DeleteLayoutResponse) String

func (x *DeleteLayoutResponse) String() string

type Event

type Event struct {

	// Types that are assignable to Type:
	//
	//	*Event_Layout
	//	*Event_Layer
	Type isEvent_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

Event structure for an event sent from the layout api via the event api

func (*Event) Descriptor deprecated

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

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetLayer

func (x *Event) GetLayer() *LayerEvent

func (*Event) GetLayout

func (x *Event) GetLayout() *LayoutEvent

func (*Event) GetType

func (m *Event) GetType() isEvent_Type

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect

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

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

type EventSubType

type EventSubType int32
const (
	EventSubType_EVENT_SUB_TYPE_UNSPECIFIED EventSubType = 0
	EventSubType_EVENT_SUB_TYPE_CREATE      EventSubType = 1
	EventSubType_EVENT_SUB_TYPE_UPDATE      EventSubType = 2
	EventSubType_EVENT_SUB_TYPE_DELETE      EventSubType = 3
	EventSubType_EVENT_SUB_TYPE_BATCH       EventSubType = 4
)

func (EventSubType) Descriptor

func (EventSubType) Enum

func (x EventSubType) Enum() *EventSubType

func (EventSubType) EnumDescriptor deprecated

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

Deprecated: Use EventSubType.Descriptor instead.

func (EventSubType) Number

func (EventSubType) String

func (x EventSubType) String() string

func (EventSubType) Type

type EventType

type EventType int32
const (
	EventType_EVENT_TYPE_UNSPECIFIED EventType = 0
	EventType_EVENT_TYPE_LAYOUT      EventType = 1
	EventType_EVENT_TYPE_LAYER       EventType = 2
)

func (EventType) Descriptor

func (EventType) Descriptor() protoreflect.EnumDescriptor

func (EventType) Enum

func (x EventType) Enum() *EventType

func (EventType) EnumDescriptor deprecated

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

Deprecated: Use EventType.Descriptor instead.

func (EventType) Number

func (x EventType) Number() protoreflect.EnumNumber

func (EventType) String

func (x EventType) String() string

func (EventType) Type

type Event_Layer

type Event_Layer struct {
	Layer *LayerEvent `protobuf:"bytes,2,opt,name=layer,proto3,oneof"`
}

type Event_Layout

type Event_Layout struct {
	Layout *LayoutEvent `protobuf:"bytes,1,opt,name=layout,proto3,oneof"`
}

type GetLayerRequest

type GetLayerRequest struct {

	// the id of the Layout
	LayoutId string `protobuf:"bytes,1,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// the id of the Layer
	LayerId string `protobuf:"bytes,2,opt,name=layer_id,json=layerId,proto3" json:"layer_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetLayerRequest) Descriptor deprecated

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

Deprecated: Use GetLayerRequest.ProtoReflect.Descriptor instead.

func (*GetLayerRequest) GetLayerId

func (x *GetLayerRequest) GetLayerId() string

func (*GetLayerRequest) GetLayoutId

func (x *GetLayerRequest) GetLayoutId() string

func (*GetLayerRequest) ProtoMessage

func (*GetLayerRequest) ProtoMessage()

func (*GetLayerRequest) ProtoReflect

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

func (*GetLayerRequest) Reset

func (x *GetLayerRequest) Reset()

func (*GetLayerRequest) String

func (x *GetLayerRequest) String() string

type GetLayoutRequest

type GetLayoutRequest struct {

	// the id of the Layout
	LayoutId string `protobuf:"bytes,1,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetLayoutRequest) Descriptor deprecated

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

Deprecated: Use GetLayoutRequest.ProtoReflect.Descriptor instead.

func (*GetLayoutRequest) GetLayoutId

func (x *GetLayoutRequest) GetLayoutId() string

func (*GetLayoutRequest) ProtoMessage

func (*GetLayoutRequest) ProtoMessage()

func (*GetLayoutRequest) ProtoReflect

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

func (*GetLayoutRequest) Reset

func (x *GetLayoutRequest) Reset()

func (*GetLayoutRequest) String

func (x *GetLayoutRequest) String() string

type Layer

type Layer struct {

	// the type of layer we're interacting with: e.g alert, banner
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Custom value for the layer. This is freeform.
	Data *structpb.Struct `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// x position in pixels. This can be null if the layer has no absolute position.
	X *structpb.Value `protobuf:"bytes,3,opt,name=x,proto3" json:"x,omitempty"`
	// y position in pixels. Can be null if the layer has no absolute position.
	Y *structpb.Value `protobuf:"bytes,4,opt,name=y,proto3" json:"y,omitempty"`
	// width in pixels of the layer. can be null if the layer is dynamically sizable.
	Width *structpb.Value `protobuf:"bytes,5,opt,name=width,proto3" json:"width,omitempty"`
	// height in pixels of the layer. can be null if the layer is dynamically sizable.
	Height *structpb.Value `protobuf:"bytes,6,opt,name=height,proto3" json:"height,omitempty"`
	// rotation of layer in degrees of the layer.
	Rotation float64 `protobuf:"fixed64,7,opt,name=rotation,proto3" json:"rotation,omitempty"`
	// opacity of the layer. This is the same as the CSS value, 0 being transparent and 1 being opaque.
	Opacity float64 `protobuf:"fixed64,8,opt,name=opacity,proto3" json:"opacity,omitempty"`
	// Scale of the layer. This is expontential, with 1 equaling the normal size of the layer.
	// note: width/height will be affected.
	Scale float64 `protobuf:"fixed64,9,opt,name=scale,proto3" json:"scale,omitempty"`
	// whether the layer should be rendered.
	Hidden bool `protobuf:"varint,10,opt,name=hidden,proto3" json:"hidden,omitempty"`
	// children of the layer.
	Children *structpb.ListValue `protobuf:"bytes,12,opt,name=children,proto3" json:"children,omitempty"`
	// Custom metadata for the layer. This is freeform.
	Metadata *structpb.Value `protobuf:"bytes,14,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// id of the layer
	Id string `protobuf:"bytes,100,opt,name=id,proto3" json:"id,omitempty"`
	// the layout this layer is associated with.
	LayoutId string `protobuf:"bytes,102,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// Metadata sent with the request
	RequestMetadata *structpb.Value `protobuf:"bytes,101,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// Animation information for the layer which should be applied on update.
	RequestAnimation []*LayerAnimation `protobuf:"bytes,103,rep,name=request_animation,json=requestAnimation,proto3" json:"request_animation,omitempty"`
	// contains filtered or unexported fields
}

The Layer represents a single item within a layout.

func (*Layer) Descriptor deprecated

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

Deprecated: Use Layer.ProtoReflect.Descriptor instead.

func (*Layer) GetChildren

func (x *Layer) GetChildren() *structpb.ListValue

func (*Layer) GetData

func (x *Layer) GetData() *structpb.Struct

func (*Layer) GetHeight

func (x *Layer) GetHeight() *structpb.Value

func (*Layer) GetHidden

func (x *Layer) GetHidden() bool

func (*Layer) GetId

func (x *Layer) GetId() string

func (*Layer) GetLayoutId

func (x *Layer) GetLayoutId() string

func (*Layer) GetMetadata

func (x *Layer) GetMetadata() *structpb.Value

func (*Layer) GetOpacity

func (x *Layer) GetOpacity() float64

func (*Layer) GetRequestAnimation

func (x *Layer) GetRequestAnimation() []*LayerAnimation

func (*Layer) GetRequestMetadata

func (x *Layer) GetRequestMetadata() *structpb.Value

func (*Layer) GetRotation

func (x *Layer) GetRotation() float64

func (*Layer) GetScale

func (x *Layer) GetScale() float64

func (*Layer) GetType

func (x *Layer) GetType() string

func (*Layer) GetWidth

func (x *Layer) GetWidth() *structpb.Value

func (*Layer) GetX

func (x *Layer) GetX() *structpb.Value

func (*Layer) GetY

func (x *Layer) GetY() *structpb.Value

func (*Layer) ProtoMessage

func (*Layer) ProtoMessage()

func (*Layer) ProtoReflect

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

func (*Layer) Reset

func (x *Layer) Reset()

func (*Layer) String

func (x *Layer) String() string

type LayerAnimation

type LayerAnimation struct {

	// The properties to animate on. Currently x, y, width, height, opacity and scale are supported. "*" can be used to target all properties.
	Properties []string `protobuf:"bytes,1,rep,name=properties,proto3" json:"properties,omitempty"`
	// The duration to transition over in milliseconds
	DurationMs int32 `protobuf:"varint,2,opt,name=duration_ms,json=durationMs,proto3" json:"duration_ms,omitempty"`
	// A delay to offset the animation by.
	DelayMs *int32 `protobuf:"varint,4,opt,name=delay_ms,json=delayMs,proto3,oneof" json:"delay_ms,omitempty"`
	// The easing mode for the transition.
	// This value can be anything supported as an easing function: https://developer.mozilla.org/en-US/docs/Web/CSS/easing-function
	EasingMode *string `protobuf:"bytes,5,opt,name=easing_mode,json=easingMode,proto3,oneof" json:"easing_mode,omitempty"`
	// contains filtered or unexported fields
}

Represents how we should apply the action, transitioning from the current state to the new state. If multiple LayerAnimation's are defined, the final LayerAnimation will be used that has a matching property!

note: this is currently only supported where layout type is "scene".

func (*LayerAnimation) Descriptor deprecated

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

Deprecated: Use LayerAnimation.ProtoReflect.Descriptor instead.

func (*LayerAnimation) GetDelayMs

func (x *LayerAnimation) GetDelayMs() int32

func (*LayerAnimation) GetDurationMs

func (x *LayerAnimation) GetDurationMs() int32

func (*LayerAnimation) GetEasingMode

func (x *LayerAnimation) GetEasingMode() string

func (*LayerAnimation) GetProperties

func (x *LayerAnimation) GetProperties() []string

func (*LayerAnimation) ProtoMessage

func (*LayerAnimation) ProtoMessage()

func (*LayerAnimation) ProtoReflect

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

func (*LayerAnimation) Reset

func (x *LayerAnimation) Reset()

func (*LayerAnimation) String

func (x *LayerAnimation) String() string

type LayerEvent

type LayerEvent struct {

	// Types that are assignable to Type:
	//
	//	*LayerEvent_Create
	//	*LayerEvent_Update
	//	*LayerEvent_Delete
	//	*LayerEvent_Batch
	Type isLayerEvent_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

func (*LayerEvent) Descriptor deprecated

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

Deprecated: Use LayerEvent.ProtoReflect.Descriptor instead.

func (*LayerEvent) GetBatch

func (x *LayerEvent) GetBatch() *BatchLayerResponse

func (*LayerEvent) GetCreate

func (x *LayerEvent) GetCreate() *Layer

func (*LayerEvent) GetDelete

func (x *LayerEvent) GetDelete() *DeleteLayerResponse

func (*LayerEvent) GetType

func (m *LayerEvent) GetType() isLayerEvent_Type

func (*LayerEvent) GetUpdate

func (x *LayerEvent) GetUpdate() *Layer

func (*LayerEvent) ProtoMessage

func (*LayerEvent) ProtoMessage()

func (*LayerEvent) ProtoReflect

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

func (*LayerEvent) Reset

func (x *LayerEvent) Reset()

func (*LayerEvent) String

func (x *LayerEvent) String() string

type LayerEvent_Batch

type LayerEvent_Batch struct {
	// Batch events
	Batch *BatchLayerResponse `protobuf:"bytes,4,opt,name=batch,proto3,oneof"`
}

type LayerEvent_Create

type LayerEvent_Create struct {
	// New layer added
	Create *Layer `protobuf:"bytes,1,opt,name=create,proto3,oneof"`
}

type LayerEvent_Delete

type LayerEvent_Delete struct {
	// Existing layer destroyed
	Delete *DeleteLayerResponse `protobuf:"bytes,3,opt,name=delete,proto3,oneof"`
}

type LayerEvent_Update

type LayerEvent_Update struct {
	// Existing layer updated
	Update *Layer `protobuf:"bytes,2,opt,name=update,proto3,oneof"`
}

type LayerServiceClient

type LayerServiceClient interface {
	// List all layers
	ListLayers(ctx context.Context, in *ListLayersRequest, opts ...grpc.CallOption) (*ListLayersResponse, error)
	// Create a layer
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	// buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE
	CreateLayer(ctx context.Context, in *CreateLayerRequest, opts ...grpc.CallOption) (*Layer, error)
	// Get a single layer
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	// buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE
	GetLayer(ctx context.Context, in *GetLayerRequest, opts ...grpc.CallOption) (*Layer, error)
	// Update a layer
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	// buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE
	UpdateLayer(ctx context.Context, in *UpdateLayerRequest, opts ...grpc.CallOption) (*Layer, error)
	// Delete a layer
	DeleteLayer(ctx context.Context, in *DeleteLayerRequest, opts ...grpc.CallOption) (*DeleteLayerResponse, error)
	// Batch update
	// buf:lint:ignore RPC_REQUEST_STANDARD_NAME
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	Batch(ctx context.Context, in *BatchLayerRequest, opts ...grpc.CallOption) (*BatchLayerResponse, error)
}

LayerServiceClient is the client API for LayerService 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.

type LayerServiceServer

type LayerServiceServer interface {
	// List all layers
	ListLayers(context.Context, *ListLayersRequest) (*ListLayersResponse, error)
	// Create a layer
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	// buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE
	CreateLayer(context.Context, *CreateLayerRequest) (*Layer, error)
	// Get a single layer
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	// buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE
	GetLayer(context.Context, *GetLayerRequest) (*Layer, error)
	// Update a layer
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	// buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE
	UpdateLayer(context.Context, *UpdateLayerRequest) (*Layer, error)
	// Delete a layer
	DeleteLayer(context.Context, *DeleteLayerRequest) (*DeleteLayerResponse, error)
	// Batch update
	// buf:lint:ignore RPC_REQUEST_STANDARD_NAME
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	Batch(context.Context, *BatchLayerRequest) (*BatchLayerResponse, error)
}

LayerServiceServer is the server API for LayerService service. All implementations should embed UnimplementedLayerServiceServer for forward compatibility

type Layout

type Layout struct {

	// internal ID for the layout
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// width of the layout in pixels
	Width int32 `protobuf:"varint,2,opt,name=width,proto3" json:"width,omitempty"`
	// height of the layout in pixels
	Height int32 `protobuf:"varint,3,opt,name=height,proto3" json:"height,omitempty"`
	// Custom metadata for the layout. This is freeform.
	Metadata     *structpb.Value `protobuf:"bytes,6,opt,name=metadata,proto3,oneof" json:"metadata,omitempty"`
	ProjectId    *string         `protobuf:"bytes,7,opt,name=project_id,json=projectId,proto3,oneof" json:"project_id,omitempty"`
	CollectionId *string         `protobuf:"bytes,8,opt,name=collection_id,json=collectionId,proto3,oneof" json:"collection_id,omitempty"`
	Type         *LayoutType     `protobuf:"varint,9,opt,name=type,proto3,enum=apis.layout.v2.LayoutType,oneof" json:"type,omitempty"`
	// Transitions to apply when switching to this scene from another
	// note: this is only available for layouts of type `LAYOUT_TYPE_SCENE`.
	Transitions []*Transition `protobuf:"bytes,10,rep,name=transitions,proto3" json:"transitions,omitempty"`
	// Metadata sent with the request
	RequestMetadata *structpb.Value `protobuf:"bytes,101,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// contains filtered or unexported fields
}

A Layout represents a container for multiple layers.

func (*Layout) Descriptor deprecated

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

Deprecated: Use Layout.ProtoReflect.Descriptor instead.

func (*Layout) GetCollectionId

func (x *Layout) GetCollectionId() string

func (*Layout) GetHeight

func (x *Layout) GetHeight() int32

func (*Layout) GetId

func (x *Layout) GetId() string

func (*Layout) GetMetadata

func (x *Layout) GetMetadata() *structpb.Value

func (*Layout) GetProjectId

func (x *Layout) GetProjectId() string

func (*Layout) GetRequestMetadata

func (x *Layout) GetRequestMetadata() *structpb.Value

func (*Layout) GetTransitions

func (x *Layout) GetTransitions() []*Transition

func (*Layout) GetType

func (x *Layout) GetType() LayoutType

func (*Layout) GetWidth

func (x *Layout) GetWidth() int32

func (*Layout) ProtoMessage

func (*Layout) ProtoMessage()

func (*Layout) ProtoReflect

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

func (*Layout) Reset

func (x *Layout) Reset()

func (*Layout) String

func (x *Layout) String() string

type LayoutEvent

type LayoutEvent struct {

	// Types that are assignable to Type:
	//
	//	*LayoutEvent_Create
	//	*LayoutEvent_Update
	//	*LayoutEvent_Delete
	Type isLayoutEvent_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

func (*LayoutEvent) Descriptor deprecated

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

Deprecated: Use LayoutEvent.ProtoReflect.Descriptor instead.

func (*LayoutEvent) GetCreate

func (x *LayoutEvent) GetCreate() *Layout

func (*LayoutEvent) GetDelete

func (x *LayoutEvent) GetDelete() *DeleteLayoutResponse

func (*LayoutEvent) GetType

func (m *LayoutEvent) GetType() isLayoutEvent_Type

func (*LayoutEvent) GetUpdate

func (x *LayoutEvent) GetUpdate() *Layout

func (*LayoutEvent) ProtoMessage

func (*LayoutEvent) ProtoMessage()

func (*LayoutEvent) ProtoReflect

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

func (*LayoutEvent) Reset

func (x *LayoutEvent) Reset()

func (*LayoutEvent) String

func (x *LayoutEvent) String() string

type LayoutEvent_Create

type LayoutEvent_Create struct {
	// New layout created
	Create *Layout `protobuf:"bytes,1,opt,name=create,proto3,oneof"`
}

type LayoutEvent_Delete

type LayoutEvent_Delete struct {
	// Existing layout destroyed
	Delete *DeleteLayoutResponse `protobuf:"bytes,3,opt,name=delete,proto3,oneof"`
}

type LayoutEvent_Update

type LayoutEvent_Update struct {
	// Existing layout updated
	Update *Layout `protobuf:"bytes,2,opt,name=update,proto3,oneof"`
}

type LayoutServiceClient

type LayoutServiceClient interface {
	// Get all layouts owned by the user.
	ListLayouts(ctx context.Context, in *ListLayoutsRequest, opts ...grpc.CallOption) (*ListLayoutsResponse, error)
	// Create a new layout
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	// buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE
	CreateLayout(ctx context.Context, in *CreateLayoutRequest, opts ...grpc.CallOption) (*Layout, error)
	// Get a layout
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	// buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE
	GetLayout(ctx context.Context, in *GetLayoutRequest, opts ...grpc.CallOption) (*Layout, error)
	// Update a layout
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	// buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE
	UpdateLayout(ctx context.Context, in *UpdateLayoutRequest, opts ...grpc.CallOption) (*Layout, error)
	// Delete a layout
	DeleteLayout(ctx context.Context, in *DeleteLayoutRequest, opts ...grpc.CallOption) (*DeleteLayoutResponse, error)
}

LayoutServiceClient is the client API for LayoutService 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.

type LayoutServiceServer

type LayoutServiceServer interface {
	// Get all layouts owned by the user.
	ListLayouts(context.Context, *ListLayoutsRequest) (*ListLayoutsResponse, error)
	// Create a new layout
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	// buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE
	CreateLayout(context.Context, *CreateLayoutRequest) (*Layout, error)
	// Get a layout
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	// buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE
	GetLayout(context.Context, *GetLayoutRequest) (*Layout, error)
	// Update a layout
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	// buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE
	UpdateLayout(context.Context, *UpdateLayoutRequest) (*Layout, error)
	// Delete a layout
	DeleteLayout(context.Context, *DeleteLayoutRequest) (*DeleteLayoutResponse, error)
}

LayoutServiceServer is the server API for LayoutService service. All implementations should embed UnimplementedLayoutServiceServer for forward compatibility

type LayoutType

type LayoutType int32

The type of layout, specifying how it functions.

const (
	LayoutType_LAYOUT_TYPE_UNSPECIFIED LayoutType = 0
	// A layout managed by Studio Kit
	LayoutType_LAYOUT_TYPE_SCENELESS LayoutType = 1
	// A layout managed via the layout API for use with our scene-based renderer.
	LayoutType_LAYOUT_TYPE_SCENE LayoutType = 2
)

func (LayoutType) Descriptor

func (LayoutType) Descriptor() protoreflect.EnumDescriptor

func (LayoutType) Enum

func (x LayoutType) Enum() *LayoutType

func (LayoutType) EnumDescriptor deprecated

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

Deprecated: Use LayoutType.Descriptor instead.

func (LayoutType) Number

func (x LayoutType) Number() protoreflect.EnumNumber

func (LayoutType) String

func (x LayoutType) String() string

func (LayoutType) Type

type ListLayersRequest

type ListLayersRequest struct {

	// the id of the Layout
	LayoutId string `protobuf:"bytes,1,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ListLayersRequest) Descriptor deprecated

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

Deprecated: Use ListLayersRequest.ProtoReflect.Descriptor instead.

func (*ListLayersRequest) GetLayoutId

func (x *ListLayersRequest) GetLayoutId() string

func (*ListLayersRequest) ProtoMessage

func (*ListLayersRequest) ProtoMessage()

func (*ListLayersRequest) ProtoReflect

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

func (*ListLayersRequest) Reset

func (x *ListLayersRequest) Reset()

func (*ListLayersRequest) String

func (x *ListLayersRequest) String() string

type ListLayersResponse

type ListLayersResponse struct {

	// list of all layers
	Layers []*Layer `protobuf:"bytes,1,rep,name=layers,proto3" json:"layers,omitempty"`
	// contains filtered or unexported fields
}

func (*ListLayersResponse) Descriptor deprecated

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

Deprecated: Use ListLayersResponse.ProtoReflect.Descriptor instead.

func (*ListLayersResponse) GetLayers

func (x *ListLayersResponse) GetLayers() []*Layer

func (*ListLayersResponse) ProtoMessage

func (*ListLayersResponse) ProtoMessage()

func (*ListLayersResponse) ProtoReflect

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

func (*ListLayersResponse) Reset

func (x *ListLayersResponse) Reset()

func (*ListLayersResponse) String

func (x *ListLayersResponse) String() string

type ListLayoutsRequest

type ListLayoutsRequest struct {
	ProjectId    *string     `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3,oneof" json:"project_id,omitempty"`
	CollectionId *string     `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3,oneof" json:"collection_id,omitempty"`
	Type         *LayoutType `protobuf:"varint,3,opt,name=type,proto3,enum=apis.layout.v2.LayoutType,oneof" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Filter options for listing layouts. Each request parameter will filter the response down (AND)

func (*ListLayoutsRequest) Descriptor deprecated

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

Deprecated: Use ListLayoutsRequest.ProtoReflect.Descriptor instead.

func (*ListLayoutsRequest) GetCollectionId

func (x *ListLayoutsRequest) GetCollectionId() string

func (*ListLayoutsRequest) GetProjectId

func (x *ListLayoutsRequest) GetProjectId() string

func (*ListLayoutsRequest) GetType

func (x *ListLayoutsRequest) GetType() LayoutType

func (*ListLayoutsRequest) ProtoMessage

func (*ListLayoutsRequest) ProtoMessage()

func (*ListLayoutsRequest) ProtoReflect

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

func (*ListLayoutsRequest) Reset

func (x *ListLayoutsRequest) Reset()

func (*ListLayoutsRequest) String

func (x *ListLayoutsRequest) String() string

type ListLayoutsResponse

type ListLayoutsResponse struct {

	// All layouts returned.
	Layouts []*Layout `protobuf:"bytes,1,rep,name=layouts,proto3" json:"layouts,omitempty"`
	// contains filtered or unexported fields
}

func (*ListLayoutsResponse) Descriptor deprecated

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

Deprecated: Use ListLayoutsResponse.ProtoReflect.Descriptor instead.

func (*ListLayoutsResponse) GetLayouts

func (x *ListLayoutsResponse) GetLayouts() []*Layout

func (*ListLayoutsResponse) ProtoMessage

func (*ListLayoutsResponse) ProtoMessage()

func (*ListLayoutsResponse) ProtoReflect

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

func (*ListLayoutsResponse) Reset

func (x *ListLayoutsResponse) Reset()

func (*ListLayoutsResponse) String

func (x *ListLayoutsResponse) String() string

type PartialLayer

type PartialLayer struct {

	// the type of layer we're interacting with: e.g alert, banner
	Type *string `protobuf:"bytes,1,opt,name=type,proto3,oneof" json:"type,omitempty"`
	// Custom value for the layer. This is freeform.
	Data *structpb.Struct `protobuf:"bytes,2,opt,name=data,proto3,oneof" json:"data,omitempty"`
	// x position in pixels. This can be null if the layer has no absolute position.
	X *structpb.Value `protobuf:"bytes,3,opt,name=x,proto3" json:"x,omitempty"`
	// y position in pixels. Can be null if the layer has no absolute position.
	Y *structpb.Value `protobuf:"bytes,4,opt,name=y,proto3" json:"y,omitempty"`
	// width in pixels of the layer. can be null if the layer is dynamically sizable.
	Width *structpb.Value `protobuf:"bytes,5,opt,name=width,proto3" json:"width,omitempty"`
	// height in pixels of the layer. can be null if the layer is dynamically sizable.
	Height *structpb.Value `protobuf:"bytes,6,opt,name=height,proto3" json:"height,omitempty"`
	// rotation of layer in degrees of the layer.
	Rotation *float64 `protobuf:"fixed64,7,opt,name=rotation,proto3,oneof" json:"rotation,omitempty"`
	// opacity of the layer. This is the same as the CSS value, 0 being transparent and 1 being opaque.
	Opacity *float64 `protobuf:"fixed64,8,opt,name=opacity,proto3,oneof" json:"opacity,omitempty"`
	// Scale of the layer. This is expontential, with 1 equaling the normal size of the layer.
	// note: width/height will be affected.
	Scale *float64 `protobuf:"fixed64,9,opt,name=scale,proto3,oneof" json:"scale,omitempty"`
	// whether the layer should be rendered.
	Hidden *bool `protobuf:"varint,10,opt,name=hidden,proto3,oneof" json:"hidden,omitempty"`
	// children of the layer.
	Children *structpb.ListValue `protobuf:"bytes,12,opt,name=children,proto3,oneof" json:"children,omitempty"`
	// parent layer to asssign to.
	ParentId *string         `protobuf:"bytes,13,opt,name=parent_id,json=parentId,proto3,oneof" json:"parent_id,omitempty"`
	Metadata *structpb.Value `protobuf:"bytes,14,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Metadata sent with the request
	RequestMetadata *structpb.Value `protobuf:"bytes,100,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// Animation information for the layer.
	RequestAnimation []*LayerAnimation `protobuf:"bytes,103,rep,name=request_animation,json=requestAnimation,proto3" json:"request_animation,omitempty"`
	// contains filtered or unexported fields
}

Partial Layer for creating and updating.

func (*PartialLayer) Descriptor deprecated

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

Deprecated: Use PartialLayer.ProtoReflect.Descriptor instead.

func (*PartialLayer) GetChildren

func (x *PartialLayer) GetChildren() *structpb.ListValue

func (*PartialLayer) GetData

func (x *PartialLayer) GetData() *structpb.Struct

func (*PartialLayer) GetHeight

func (x *PartialLayer) GetHeight() *structpb.Value

func (*PartialLayer) GetHidden

func (x *PartialLayer) GetHidden() bool

func (*PartialLayer) GetMetadata

func (x *PartialLayer) GetMetadata() *structpb.Value

func (*PartialLayer) GetOpacity

func (x *PartialLayer) GetOpacity() float64

func (*PartialLayer) GetParentId

func (x *PartialLayer) GetParentId() string

func (*PartialLayer) GetRequestAnimation

func (x *PartialLayer) GetRequestAnimation() []*LayerAnimation

func (*PartialLayer) GetRequestMetadata

func (x *PartialLayer) GetRequestMetadata() *structpb.Value

func (*PartialLayer) GetRotation

func (x *PartialLayer) GetRotation() float64

func (*PartialLayer) GetScale

func (x *PartialLayer) GetScale() float64

func (*PartialLayer) GetType

func (x *PartialLayer) GetType() string

func (*PartialLayer) GetWidth

func (x *PartialLayer) GetWidth() *structpb.Value

func (*PartialLayer) GetX

func (x *PartialLayer) GetX() *structpb.Value

func (*PartialLayer) GetY

func (x *PartialLayer) GetY() *structpb.Value

func (*PartialLayer) ProtoMessage

func (*PartialLayer) ProtoMessage()

func (*PartialLayer) ProtoReflect

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

func (*PartialLayer) Reset

func (x *PartialLayer) Reset()

func (*PartialLayer) String

func (x *PartialLayer) String() string

type PartialLayerWithID

type PartialLayerWithID struct {

	// ID of the layer.
	Id string `protobuf:"bytes,1000,opt,name=id,proto3" json:"id,omitempty"`
	// the type of layer we're interacting with: e.g alert, banner
	Type *string `protobuf:"bytes,1,opt,name=type,proto3,oneof" json:"type,omitempty"`
	// Custom value for the layer. This is freeform.
	Data *structpb.Struct `protobuf:"bytes,2,opt,name=data,proto3,oneof" json:"data,omitempty"`
	// x position in pixels. This can be null if the layer has no absolute position.
	X *structpb.Value `protobuf:"bytes,3,opt,name=x,proto3" json:"x,omitempty"`
	// y position in pixels. Can be null if the layer has no absolute position.
	Y *structpb.Value `protobuf:"bytes,4,opt,name=y,proto3" json:"y,omitempty"`
	// width in pixels of the layer. can be null if the layer is dynamically sizable.
	Width *structpb.Value `protobuf:"bytes,5,opt,name=width,proto3" json:"width,omitempty"`
	// height in pixels of the layer. can be null if the layer is dynamically sizable.
	Height *structpb.Value `protobuf:"bytes,6,opt,name=height,proto3" json:"height,omitempty"`
	// rotation of layer in degrees of the layer.
	Rotation *float64 `protobuf:"fixed64,7,opt,name=rotation,proto3,oneof" json:"rotation,omitempty"`
	// opacity of the layer. This is the same as the CSS value, 0 being transparent and 1 being opaque.
	Opacity *float64 `protobuf:"fixed64,8,opt,name=opacity,proto3,oneof" json:"opacity,omitempty"`
	// Scale of the layer. This is expontential, with 1 equaling the normal size of the layer.
	// note: width/height will be affected.
	Scale *float64 `protobuf:"fixed64,9,opt,name=scale,proto3,oneof" json:"scale,omitempty"`
	// whether the layer should be rendered.
	Hidden *bool `protobuf:"varint,10,opt,name=hidden,proto3,oneof" json:"hidden,omitempty"`
	// children of the layer.
	Children *structpb.ListValue `protobuf:"bytes,12,opt,name=children,proto3,oneof" json:"children,omitempty"`
	// parent layer to asssign to.
	ParentId *string         `protobuf:"bytes,13,opt,name=parent_id,json=parentId,proto3,oneof" json:"parent_id,omitempty"`
	Metadata *structpb.Value `protobuf:"bytes,14,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Metadata sent with the request
	RequestMetadata *structpb.Value `protobuf:"bytes,100,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// Animation information for the layer.
	RequestAnimation []*LayerAnimation `protobuf:"bytes,103,rep,name=request_animation,json=requestAnimation,proto3" json:"request_animation,omitempty"`
	// contains filtered or unexported fields
}

Partial Layer for updating.

func (*PartialLayerWithID) Descriptor deprecated

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

Deprecated: Use PartialLayerWithID.ProtoReflect.Descriptor instead.

func (*PartialLayerWithID) GetChildren

func (x *PartialLayerWithID) GetChildren() *structpb.ListValue

func (*PartialLayerWithID) GetData

func (x *PartialLayerWithID) GetData() *structpb.Struct

func (*PartialLayerWithID) GetHeight

func (x *PartialLayerWithID) GetHeight() *structpb.Value

func (*PartialLayerWithID) GetHidden

func (x *PartialLayerWithID) GetHidden() bool

func (*PartialLayerWithID) GetId

func (x *PartialLayerWithID) GetId() string

func (*PartialLayerWithID) GetMetadata

func (x *PartialLayerWithID) GetMetadata() *structpb.Value

func (*PartialLayerWithID) GetOpacity

func (x *PartialLayerWithID) GetOpacity() float64

func (*PartialLayerWithID) GetParentId

func (x *PartialLayerWithID) GetParentId() string

func (*PartialLayerWithID) GetRequestAnimation

func (x *PartialLayerWithID) GetRequestAnimation() []*LayerAnimation

func (*PartialLayerWithID) GetRequestMetadata

func (x *PartialLayerWithID) GetRequestMetadata() *structpb.Value

func (*PartialLayerWithID) GetRotation

func (x *PartialLayerWithID) GetRotation() float64

func (*PartialLayerWithID) GetScale

func (x *PartialLayerWithID) GetScale() float64

func (*PartialLayerWithID) GetType

func (x *PartialLayerWithID) GetType() string

func (*PartialLayerWithID) GetWidth

func (x *PartialLayerWithID) GetWidth() *structpb.Value

func (*PartialLayerWithID) GetX

func (x *PartialLayerWithID) GetX() *structpb.Value

func (*PartialLayerWithID) GetY

func (x *PartialLayerWithID) GetY() *structpb.Value

func (*PartialLayerWithID) ProtoMessage

func (*PartialLayerWithID) ProtoMessage()

func (*PartialLayerWithID) ProtoReflect

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

func (*PartialLayerWithID) Reset

func (x *PartialLayerWithID) Reset()

func (*PartialLayerWithID) String

func (x *PartialLayerWithID) String() string

type PartialLayout

type PartialLayout struct {

	// width of the layer in pixels
	Width *int32 `protobuf:"varint,2,opt,name=width,proto3,oneof" json:"width,omitempty"`
	// height of the layer in pixels
	Height *int32 `protobuf:"varint,3,opt,name=height,proto3,oneof" json:"height,omitempty"`
	// Metadata associated with a layout. This is freeform JSON.
	Metadata *structpb.Value `protobuf:"bytes,6,opt,name=metadata,proto3,oneof" json:"metadata,omitempty"`
	// Project ID from the Live API for the layout
	// note: this cannot be changed for existing layouts.
	ProjectId *string `protobuf:"bytes,7,opt,name=project_id,json=projectId,proto3,oneof" json:"project_id,omitempty"`
	// Collection ID from the Live API for the layout
	// note: this cannot be changed once set.
	CollectionId *string `protobuf:"bytes,8,opt,name=collection_id,json=collectionId,proto3,oneof" json:"collection_id,omitempty"`
	// The type of layout to use.
	// Typically you should use LAYOUT_TYPE_SCENE to manage layouts via the API. This automatically
	// creates a "root" layer for all layers to be under.
	// LAYOUT_TYPE_SCENELESS is used for layouts managed by the Studio SDK.
	Type *LayoutType `protobuf:"varint,9,opt,name=type,proto3,enum=apis.layout.v2.LayoutType,oneof" json:"type,omitempty"`
	// Transitions to apply when switching to this scene from another
	// note: this is only available for layouts of type `LAYOUT_TYPE_SCENE`.
	Transitions []*Transition `protobuf:"bytes,10,rep,name=transitions,proto3" json:"transitions,omitempty"`
	// Metadata associated with the publishing of the event
	RequestMetadata *structpb.Value `protobuf:"bytes,101,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// contains filtered or unexported fields
}

Partial layout

func (*PartialLayout) Descriptor deprecated

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

Deprecated: Use PartialLayout.ProtoReflect.Descriptor instead.

func (*PartialLayout) GetCollectionId

func (x *PartialLayout) GetCollectionId() string

func (*PartialLayout) GetHeight

func (x *PartialLayout) GetHeight() int32

func (*PartialLayout) GetMetadata

func (x *PartialLayout) GetMetadata() *structpb.Value

func (*PartialLayout) GetProjectId

func (x *PartialLayout) GetProjectId() string

func (*PartialLayout) GetRequestMetadata

func (x *PartialLayout) GetRequestMetadata() *structpb.Value

func (*PartialLayout) GetTransitions

func (x *PartialLayout) GetTransitions() []*Transition

func (*PartialLayout) GetType

func (x *PartialLayout) GetType() LayoutType

func (*PartialLayout) GetWidth

func (x *PartialLayout) GetWidth() int32

func (*PartialLayout) ProtoMessage

func (*PartialLayout) ProtoMessage()

func (*PartialLayout) ProtoReflect

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

func (*PartialLayout) Reset

func (x *PartialLayout) Reset()

func (*PartialLayout) String

func (x *PartialLayout) String() string

type RequestAnimationMode

type RequestAnimationMode int32

Define how to apply animations in a batch request.

const (
	RequestAnimationMode_REQUEST_ANIMATION_MODE_UNSPECIFIED RequestAnimationMode = 0
	// All animations in the batch will be applied at once.
	RequestAnimationMode_REQUEST_ANIMATION_MODE_PARALLEL RequestAnimationMode = 1
	// Each layer update will appy after all animations on the previous layer(s) have completed.
	RequestAnimationMode_REQUEST_ANIMATION_MODE_SERIES RequestAnimationMode = 2
)

func (RequestAnimationMode) Descriptor

func (RequestAnimationMode) Enum

func (RequestAnimationMode) EnumDescriptor deprecated

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

Deprecated: Use RequestAnimationMode.Descriptor instead.

func (RequestAnimationMode) Number

func (RequestAnimationMode) String

func (x RequestAnimationMode) String() string

func (RequestAnimationMode) Type

type Transition

type Transition struct {

	// A list of layout IDs to apply this transition to. If empty,
	// this transition will apply to all scene switches which _do not_ have a matching transition.
	// If multiple transitions match (e.g multiple targetting the layout), a transition will be chosen at random.
	FromLayoutIds []string `protobuf:"bytes,1,rep,name=from_layout_ids,json=fromLayoutIds,proto3" json:"from_layout_ids,omitempty"`
	// The type of transition to play.
	//
	// Types that are assignable to TransitionType:
	//
	//	*Transition_Cut
	//	*Transition_Crossfade
	//	*Transition_FadeToColor
	//	*Transition_Swipe
	//	*Transition_Stinger
	TransitionType isTransition_TransitionType `protobuf_oneof:"transition_type"`
	// contains filtered or unexported fields
}

Transition defines a transition into this layout.

func (*Transition) Descriptor deprecated

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

Deprecated: Use Transition.ProtoReflect.Descriptor instead.

func (*Transition) GetCrossfade

func (x *Transition) GetCrossfade() *Transition_TransitionCrossfade

func (*Transition) GetCut

func (x *Transition) GetCut() *Transition_TransitionCut

func (*Transition) GetFadeToColor

func (x *Transition) GetFadeToColor() *Transition_TransitionFadeToColor

func (*Transition) GetFromLayoutIds

func (x *Transition) GetFromLayoutIds() []string

func (*Transition) GetStinger

func (x *Transition) GetStinger() *Transition_TransitionStinger

func (*Transition) GetSwipe

func (x *Transition) GetSwipe() *Transition_TransitionSwipe

func (*Transition) GetTransitionType

func (m *Transition) GetTransitionType() isTransition_TransitionType

func (*Transition) ProtoMessage

func (*Transition) ProtoMessage()

func (*Transition) ProtoReflect

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

func (*Transition) Reset

func (x *Transition) Reset()

func (*Transition) String

func (x *Transition) String() string

type Transition_Crossfade

type Transition_Crossfade struct {
	Crossfade *Transition_TransitionCrossfade `protobuf:"bytes,11,opt,name=crossfade,proto3,oneof"`
}

type Transition_Cut

type Transition_Cut struct {
	Cut *Transition_TransitionCut `protobuf:"bytes,10,opt,name=cut,proto3,oneof"`
}

type Transition_FadeToColor

type Transition_FadeToColor struct {
	FadeToColor *Transition_TransitionFadeToColor `protobuf:"bytes,12,opt,name=fade_to_color,json=fadeToColor,proto3,oneof"`
}

type Transition_Stinger

type Transition_Stinger struct {
	Stinger *Transition_TransitionStinger `protobuf:"bytes,14,opt,name=stinger,proto3,oneof"`
}

type Transition_Swipe

type Transition_Swipe struct {
	Swipe *Transition_TransitionSwipe `protobuf:"bytes,13,opt,name=swipe,proto3,oneof"`
}

type Transition_TransitionCrossfade

type Transition_TransitionCrossfade struct {

	// The duration to animate over.
	DurationMs int32 `protobuf:"varint,1,opt,name=duration_ms,json=durationMs,proto3" json:"duration_ms,omitempty"`
	// contains filtered or unexported fields
}

Transition: crossfade between two layouts.

func (*Transition_TransitionCrossfade) Descriptor deprecated

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

Deprecated: Use Transition_TransitionCrossfade.ProtoReflect.Descriptor instead.

func (*Transition_TransitionCrossfade) GetDurationMs

func (x *Transition_TransitionCrossfade) GetDurationMs() int32

func (*Transition_TransitionCrossfade) ProtoMessage

func (*Transition_TransitionCrossfade) ProtoMessage()

func (*Transition_TransitionCrossfade) ProtoReflect

func (*Transition_TransitionCrossfade) Reset

func (x *Transition_TransitionCrossfade) Reset()

func (*Transition_TransitionCrossfade) String

type Transition_TransitionCut

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

Transition: a simple scene switch. this is the default transition.

func (*Transition_TransitionCut) Descriptor deprecated

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

Deprecated: Use Transition_TransitionCut.ProtoReflect.Descriptor instead.

func (*Transition_TransitionCut) ProtoMessage

func (*Transition_TransitionCut) ProtoMessage()

func (*Transition_TransitionCut) ProtoReflect

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

func (*Transition_TransitionCut) Reset

func (x *Transition_TransitionCut) Reset()

func (*Transition_TransitionCut) String

func (x *Transition_TransitionCut) String() string

type Transition_TransitionDirection

type Transition_TransitionDirection int32

Direction for the animation to display in.

const (
	Transition_TRANSITION_DIRECTION_UNSPECIFIED Transition_TransitionDirection = 0
	Transition_TRANSITION_DIRECTION_LEFT        Transition_TransitionDirection = 1
	Transition_TRANSITION_DIRECTION_RIGHT       Transition_TransitionDirection = 2
	Transition_TRANSITION_DIRECTION_UP          Transition_TransitionDirection = 3
	Transition_TRANSITION_DIRECTION_DOWN        Transition_TransitionDirection = 4
)

func (Transition_TransitionDirection) Descriptor

func (Transition_TransitionDirection) Enum

func (Transition_TransitionDirection) EnumDescriptor deprecated

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

Deprecated: Use Transition_TransitionDirection.Descriptor instead.

func (Transition_TransitionDirection) Number

func (Transition_TransitionDirection) String

func (Transition_TransitionDirection) Type

type Transition_TransitionFadeToColor

type Transition_TransitionFadeToColor struct {

	// The duration to animate over. The fade to color will take half this duration.
	DurationMs int32 `protobuf:"varint,1,opt,name=duration_ms,json=durationMs,proto3" json:"duration_ms,omitempty"`
	// A CSS-compatible background color.
	BackgroundColor string `protobuf:"bytes,2,opt,name=background_color,json=backgroundColor,proto3" json:"background_color,omitempty"`
	// contains filtered or unexported fields
}

Transition: Fade to a color before transitioning to another layout.

func (*Transition_TransitionFadeToColor) Descriptor deprecated

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

Deprecated: Use Transition_TransitionFadeToColor.ProtoReflect.Descriptor instead.

func (*Transition_TransitionFadeToColor) GetBackgroundColor

func (x *Transition_TransitionFadeToColor) GetBackgroundColor() string

func (*Transition_TransitionFadeToColor) GetDurationMs

func (x *Transition_TransitionFadeToColor) GetDurationMs() int32

func (*Transition_TransitionFadeToColor) ProtoMessage

func (*Transition_TransitionFadeToColor) ProtoMessage()

func (*Transition_TransitionFadeToColor) ProtoReflect

func (*Transition_TransitionFadeToColor) Reset

func (*Transition_TransitionFadeToColor) String

type Transition_TransitionMediaType

type Transition_TransitionMediaType struct {

	// External URL to the media content.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// Volume to play the media at between 0 and 1.
	Volume float64 `protobuf:"fixed64,2,opt,name=volume,proto3" json:"volume,omitempty"`
	// contains filtered or unexported fields
}

Media definition

func (*Transition_TransitionMediaType) Descriptor deprecated

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

Deprecated: Use Transition_TransitionMediaType.ProtoReflect.Descriptor instead.

func (*Transition_TransitionMediaType) GetUrl

func (*Transition_TransitionMediaType) GetVolume

func (x *Transition_TransitionMediaType) GetVolume() float64

func (*Transition_TransitionMediaType) ProtoMessage

func (*Transition_TransitionMediaType) ProtoMessage()

func (*Transition_TransitionMediaType) ProtoReflect

func (*Transition_TransitionMediaType) Reset

func (x *Transition_TransitionMediaType) Reset()

func (*Transition_TransitionMediaType) String

type Transition_TransitionStinger

type Transition_TransitionStinger struct {

	// Types that are assignable to StingerType:
	//
	//	*Transition_TransitionStinger_Cut
	StingerType isTransition_TransitionStinger_StingerType `protobuf_oneof:"stinger_type"`
	// contains filtered or unexported fields
}

Transition: stinger animation.

func (*Transition_TransitionStinger) Descriptor deprecated

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

Deprecated: Use Transition_TransitionStinger.ProtoReflect.Descriptor instead.

func (*Transition_TransitionStinger) GetCut

func (*Transition_TransitionStinger) GetStingerType

func (m *Transition_TransitionStinger) GetStingerType() isTransition_TransitionStinger_StingerType

func (*Transition_TransitionStinger) ProtoMessage

func (*Transition_TransitionStinger) ProtoMessage()

func (*Transition_TransitionStinger) ProtoReflect

func (*Transition_TransitionStinger) Reset

func (x *Transition_TransitionStinger) Reset()

func (*Transition_TransitionStinger) String

type Transition_TransitionStingerCut

type Transition_TransitionStingerCut struct {

	// The duration from the start of the media playing at which the layout should change.
	// this should be a point where the entire screen is filled.
	CutPointMs int32 `protobuf:"varint,1,opt,name=cut_point_ms,json=cutPointMs,proto3" json:"cut_point_ms,omitempty"`
	// The remote media to play as the stinger.
	Media *Transition_TransitionMediaType `protobuf:"bytes,2,opt,name=media,proto3" json:"media,omitempty"`
	// contains filtered or unexported fields
}

Stinger where the layout is cut over at a specific point.

func (*Transition_TransitionStingerCut) Descriptor deprecated

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

Deprecated: Use Transition_TransitionStingerCut.ProtoReflect.Descriptor instead.

func (*Transition_TransitionStingerCut) GetCutPointMs

func (x *Transition_TransitionStingerCut) GetCutPointMs() int32

func (*Transition_TransitionStingerCut) GetMedia

func (*Transition_TransitionStingerCut) ProtoMessage

func (*Transition_TransitionStingerCut) ProtoMessage()

func (*Transition_TransitionStingerCut) ProtoReflect

func (*Transition_TransitionStingerCut) Reset

func (*Transition_TransitionStingerCut) String

type Transition_TransitionStinger_Cut

type Transition_TransitionStinger_Cut struct {
	Cut *Transition_TransitionStingerCut `protobuf:"bytes,1,opt,name=cut,proto3,oneof"`
}

type Transition_TransitionSwipe

type Transition_TransitionSwipe struct {

	// The duration to animate over.
	DurationMs int32 `protobuf:"varint,1,opt,name=duration_ms,json=durationMs,proto3" json:"duration_ms,omitempty"`
	// The direction to swipe the layer from.
	Direction Transition_TransitionDirection `protobuf:"varint,2,opt,name=direction,proto3,enum=apis.layout.v2.Transition_TransitionDirection" json:"direction,omitempty"`
	// How to animate the slide.
	CombinedAnimation Transition_TransitionSwipeType `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

Transition: Animation where layouts are slide over another.

func (*Transition_TransitionSwipe) Descriptor deprecated

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

Deprecated: Use Transition_TransitionSwipe.ProtoReflect.Descriptor instead.

func (*Transition_TransitionSwipe) GetCombinedAnimation

func (*Transition_TransitionSwipe) GetDirection

func (*Transition_TransitionSwipe) GetDurationMs

func (x *Transition_TransitionSwipe) GetDurationMs() int32

func (*Transition_TransitionSwipe) ProtoMessage

func (*Transition_TransitionSwipe) ProtoMessage()

func (*Transition_TransitionSwipe) ProtoReflect

func (*Transition_TransitionSwipe) Reset

func (x *Transition_TransitionSwipe) Reset()

func (*Transition_TransitionSwipe) String

func (x *Transition_TransitionSwipe) String() string

type Transition_TransitionSwipeType

type Transition_TransitionSwipeType int32
const (
	// Both layouts are animated together
	Transition_TRANSITION_SWIPE_TYPE_UNSPECIFIED Transition_TransitionSwipeType = 0
	// Both layouts are animated together
	Transition_TRANSITION_SWIPE_TYPE_COMBINED Transition_TransitionSwipeType = 1
	// The source animation is moved out of the way
	Transition_TRANSITION_SWIPE_TYPE_SOURCE Transition_TransitionSwipeType = 2
	// The destination layout is overlaid
	Transition_TRANSITION_SWIPE_TYPE_DESTINATION Transition_TransitionSwipeType = 3
)

func (Transition_TransitionSwipeType) Descriptor

func (Transition_TransitionSwipeType) Enum

func (Transition_TransitionSwipeType) EnumDescriptor deprecated

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

Deprecated: Use Transition_TransitionSwipeType.Descriptor instead.

func (Transition_TransitionSwipeType) Number

func (Transition_TransitionSwipeType) String

func (Transition_TransitionSwipeType) Type

type UnimplementedLayerServiceServer

type UnimplementedLayerServiceServer struct {
}

UnimplementedLayerServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedLayerServiceServer) Batch

func (UnimplementedLayerServiceServer) CreateLayer

func (UnimplementedLayerServiceServer) DeleteLayer

func (UnimplementedLayerServiceServer) GetLayer

func (UnimplementedLayerServiceServer) ListLayers

func (UnimplementedLayerServiceServer) UpdateLayer

type UnimplementedLayoutServiceServer

type UnimplementedLayoutServiceServer struct {
}

UnimplementedLayoutServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedLayoutServiceServer) CreateLayout

func (UnimplementedLayoutServiceServer) DeleteLayout

func (UnimplementedLayoutServiceServer) GetLayout

func (UnimplementedLayoutServiceServer) ListLayouts

func (UnimplementedLayoutServiceServer) UpdateLayout

type UnsafeLayerServiceServer

type UnsafeLayerServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeLayerServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to LayerServiceServer will result in compilation errors.

type UnsafeLayoutServiceServer

type UnsafeLayoutServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeLayoutServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to LayoutServiceServer will result in compilation errors.

type UpdateLayerRequest

type UpdateLayerRequest struct {

	// the id of the Layout
	LayoutId string `protobuf:"bytes,1,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// the id of the Layer
	LayerId string `protobuf:"bytes,2,opt,name=layer_id,json=layerId,proto3" json:"layer_id,omitempty"`
	// layer data to update with.
	Layer *PartialLayer `protobuf:"bytes,3,opt,name=layer,proto3" json:"layer,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateLayerRequest) Descriptor deprecated

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

Deprecated: Use UpdateLayerRequest.ProtoReflect.Descriptor instead.

func (*UpdateLayerRequest) GetLayer

func (x *UpdateLayerRequest) GetLayer() *PartialLayer

func (*UpdateLayerRequest) GetLayerId

func (x *UpdateLayerRequest) GetLayerId() string

func (*UpdateLayerRequest) GetLayoutId

func (x *UpdateLayerRequest) GetLayoutId() string

func (*UpdateLayerRequest) ProtoMessage

func (*UpdateLayerRequest) ProtoMessage()

func (*UpdateLayerRequest) ProtoReflect

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

func (*UpdateLayerRequest) Reset

func (x *UpdateLayerRequest) Reset()

func (*UpdateLayerRequest) String

func (x *UpdateLayerRequest) String() string

type UpdateLayoutRequest

type UpdateLayoutRequest struct {

	// the id of the Layout
	LayoutId string `protobuf:"bytes,1,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// layout data to update with.
	Layout *PartialLayout `protobuf:"bytes,3,opt,name=layout,proto3" json:"layout,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateLayoutRequest) Descriptor deprecated

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

Deprecated: Use UpdateLayoutRequest.ProtoReflect.Descriptor instead.

func (*UpdateLayoutRequest) GetLayout

func (x *UpdateLayoutRequest) GetLayout() *PartialLayout

func (*UpdateLayoutRequest) GetLayoutId

func (x *UpdateLayoutRequest) GetLayoutId() string

func (*UpdateLayoutRequest) ProtoMessage

func (*UpdateLayoutRequest) ProtoMessage()

func (*UpdateLayoutRequest) ProtoReflect

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

func (*UpdateLayoutRequest) Reset

func (x *UpdateLayoutRequest) Reset()

func (*UpdateLayoutRequest) String

func (x *UpdateLayoutRequest) String() string

Jump to

Keyboard shortcuts

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