@norskvideo/norsk-api 0.0.327 → 0.0.329

package/lib/media_pb.d.ts

@@ -1037,6 +1037,31 @@ export declare enum VideoIOSupport {
      */
     PLAYBACK = 1
 }
+/**
+ * @generated from enum norsk.api.media.ContextType
+ */
+export declare enum ContextType {
+    /**
+     * @generated from enum value: CONTEXT_TYPE_FULL = 0;
+     */
+    FULL = 0,
+    /**
+     * @generated from enum value: CONTEXT_TYPE_SINGLE_SOURCE = 1;
+     */
+    SINGLE_SOURCE = 1,
+    /**
+     * @generated from enum value: CONTEXT_TYPE_SINGLE_PROGRAM = 2;
+     */
+    SINGLE_PROGRAM = 2,
+    /**
+     * @generated from enum value: CONTEXT_TYPE_SINGLE_STREAM = 3;
+     */
+    SINGLE_STREAM = 3,
+    /**
+     * @generated from enum value: CONTEXT_TYPE_SINGLE_RENDITION = 4;
+     */
+    SINGLE_RENDITION = 4
+}
 /**
  * The canonical error codes for gRPC APIs.
  *
@@ -4220,13 +4245,14 @@ export declare class ComposePart extends Message<ComposePart> {
     destRect?: OffsetRectangle;
     /**
      * Z-index to determine ordering by which the sources are overlaid
+     * (higher layers appear on top)
      *
      * @generated from field: uint32 z_index = 4;
      */
     zIndex: number;
     /**
-     * Opacity of this overlay (where 0.0 is fully transparent and 1.0 is fully
-     * opaque)
+     * Opacity multiplier of this overlay (where 0.0 is fully transparent and 1.0
+     * is fully opaque)
      *
      * @generated from field: float opacity = 5;
      */
@@ -4408,7 +4434,7 @@ export declare class ComposeVideoMessage extends Message<ComposeVideoMessage> {
 }
 /**
  * *
- * Configure an Compose Media Node.
+ * Configure a Compose Media Node.
  *
  * @generated from message norsk.api.media.ComposeVideoConfiguration
  */
@@ -4552,7 +4578,7 @@ export declare enum ComposeVideoConfiguration_MissingStreamBehaviour {
  */
 export declare class ComposeVideoUpdateConfiguration extends Message<ComposeVideoUpdateConfiguration> {
     /**
-     * The parts (images/overlays) to include in the composition
+     * Update the parts (images/overlays) to include in the composition
      *
      * @generated from field: repeated norsk.api.media.ComposePart parts = 1;
      */
@@ -10482,17 +10508,17 @@ export declare class SubscribeSource extends Message<SubscribeSource> {
  */
 export declare class Subscription extends Message<Subscription> {
     /**
-     * The individual subscription components
+     * An arbitrary id of the subscription, to enable correlating of the corresponding subscription response
      *
-     * @generated from field: repeated norsk.api.media.SubscribeSource sources = 2;
+     * @generated from field: string id = 1;
      */
-    sources: SubscribeSource[];
+    id: string;
     /**
-     * An arbitrary id of the subscription, to enable correlating of the corresponding subscription response
+     * The individual subscription components
      *
-     * @generated from field: string id = 3;
+     * @generated from field: repeated norsk.api.media.SubscribeSource sources = 2;
      */
-    id: string;
+    sources: SubscribeSource[];
     constructor(data?: PartialMessage<Subscription>);
     static readonly runtime: import("@bufbuild/protobuf/dist/types/private/proto-runtime.js").ProtoRuntime;
     static readonly typeName = "norsk.api.media.Subscription";
@@ -10509,17 +10535,17 @@ export declare class Subscription extends Message<Subscription> {
  */
 export declare class SubscriptionResponse extends Message<SubscriptionResponse> {
     /**
-     * The subscription status
+     * The id of the subscription which this message is a response to
      *
-     * @generated from field: norsk.api.media.Status status = 2;
+     * @generated from field: string id = 1;
      */
-    status?: Status;
+    id: string;
     /**
-     * The id of the subscription which this message is a response to
+     * The error that prevented the subscription, if any
      *
-     * @generated from field: string id = 3;
+     * @generated from field: norsk.api.media.SubscriptionError error = 2;
      */
-    id: string;
+    error?: SubscriptionError;
     constructor(data?: PartialMessage<SubscriptionResponse>);
     static readonly runtime: import("@bufbuild/protobuf/dist/types/private/proto-runtime.js").ProtoRuntime;
     static readonly typeName = "norsk.api.media.SubscriptionResponse";
@@ -10529,6 +10555,227 @@ export declare class SubscriptionResponse extends Message<SubscriptionResponse>
     static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SubscriptionResponse;
     static equals(a: SubscriptionResponse | PlainMessage<SubscriptionResponse> | undefined, b: SubscriptionResponse | PlainMessage<SubscriptionResponse> | undefined): boolean;
 }
+/**
+ * @generated from message norsk.api.media.SubscriptionError
+ */
+export declare class SubscriptionError extends Message<SubscriptionError> {
+    /**
+     * @generated from oneof norsk.api.media.SubscriptionError.error
+     */
+    error: {
+        /**
+         * An opaque internal error
+         *
+         * @generated from field: string internal = 1;
+         */
+        value: string;
+        case: "internal";
+    } | {
+        /**
+         * The media node requesting the subscription does not exist
+         *
+         * @generated from field: norsk.api.media.MediaNodeId unknown_subscriber = 2;
+         */
+        value: MediaNodeId;
+        case: "unknownSubscriber";
+    } | {
+        /**
+         * Multiple stream keys found for the context type
+         *
+         * @generated from field: norsk.api.media.SubscriptionError.MultipleStreams multiple_streams = 3;
+         */
+        value: SubscriptionError_MultipleStreams;
+        case: "multipleStreams";
+    } | {
+        /**
+         * Per-source errors
+         *
+         * @generated from field: norsk.api.media.SubscriptionError.SourceSubscriptionErrors source_subscription_error = 4;
+         */
+        value: SubscriptionError_SourceSubscriptionErrors;
+        case: "sourceSubscriptionError";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+    constructor(data?: PartialMessage<SubscriptionError>);
+    static readonly runtime: import("@bufbuild/protobuf/dist/types/private/proto-runtime.js").ProtoRuntime;
+    static readonly typeName = "norsk.api.media.SubscriptionError";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SubscriptionError;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SubscriptionError;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SubscriptionError;
+    static equals(a: SubscriptionError | PlainMessage<SubscriptionError> | undefined, b: SubscriptionError | PlainMessage<SubscriptionError> | undefined): boolean;
+}
+/**
+ * @generated from message norsk.api.media.SubscriptionError.MultipleStreams
+ */
+export declare class SubscriptionError_MultipleStreams extends Message<SubscriptionError_MultipleStreams> {
+    /**
+     * @generated from field: norsk.api.media.ContextType context_type = 1;
+     */
+    contextType: ContextType;
+    /**
+     * @generated from field: repeated norsk.api.media.StreamKey stream_keys = 2;
+     */
+    streamKeys: StreamKey[];
+    constructor(data?: PartialMessage<SubscriptionError_MultipleStreams>);
+    static readonly runtime: import("@bufbuild/protobuf/dist/types/private/proto-runtime.js").ProtoRuntime;
+    static readonly typeName = "norsk.api.media.SubscriptionError.MultipleStreams";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SubscriptionError_MultipleStreams;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SubscriptionError_MultipleStreams;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SubscriptionError_MultipleStreams;
+    static equals(a: SubscriptionError_MultipleStreams | PlainMessage<SubscriptionError_MultipleStreams> | undefined, b: SubscriptionError_MultipleStreams | PlainMessage<SubscriptionError_MultipleStreams> | undefined): boolean;
+}
+/**
+ * @generated from message norsk.api.media.SubscriptionError.SourceSubscriptionErrors
+ */
+export declare class SubscriptionError_SourceSubscriptionErrors extends Message<SubscriptionError_SourceSubscriptionErrors> {
+    /**
+     * @generated from field: repeated norsk.api.media.SourceSubscriptionError errors = 1;
+     */
+    errors: SourceSubscriptionError[];
+    constructor(data?: PartialMessage<SubscriptionError_SourceSubscriptionErrors>);
+    static readonly runtime: import("@bufbuild/protobuf/dist/types/private/proto-runtime.js").ProtoRuntime;
+    static readonly typeName = "norsk.api.media.SubscriptionError.SourceSubscriptionErrors";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SubscriptionError_SourceSubscriptionErrors;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SubscriptionError_SourceSubscriptionErrors;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SubscriptionError_SourceSubscriptionErrors;
+    static equals(a: SubscriptionError_SourceSubscriptionErrors | PlainMessage<SubscriptionError_SourceSubscriptionErrors> | undefined, b: SubscriptionError_SourceSubscriptionErrors | PlainMessage<SubscriptionError_SourceSubscriptionErrors> | undefined): boolean;
+}
+/**
+ * @generated from message norsk.api.media.SourceSubscriptionError
+ */
+export declare class SourceSubscriptionError extends Message<SourceSubscriptionError> {
+    /**
+     * @generated from oneof norsk.api.media.SourceSubscriptionError.error
+     */
+    error: {
+        /**
+         * An opaque internal error
+         *
+         * @generated from field: string internal = 1;
+         */
+        value: string;
+        case: "internal";
+    } | {
+        /**
+         * The media node does not exist (maybe it crashed)
+         *
+         * @generated from field: norsk.api.media.MediaNodeId unknown_source_id = 2;
+         */
+        value: MediaNodeId;
+        case: "unknownSourceId";
+    } | {
+        /**
+         * The media node exists, but does not have the stream key
+         *
+         * @generated from field: norsk.api.media.SourceSubscriptionError.SourceStream unknown_source_stream = 3;
+         */
+        value: SourceSubscriptionError_SourceStream;
+        case: "unknownSourceStream";
+    } | {
+        /**
+         * The media node is not set up to receive data on this pin (which may be auto-detected)
+         *
+         * @generated from field: norsk.api.media.SourceSubscriptionError.NoSubscriberPin no_subscriber_pin = 4;
+         */
+        value: SourceSubscriptionError_NoSubscriberPin;
+        case: "noSubscriberPin";
+    } | {
+        /**
+         * Norsk does not support conversion from the media types of the source to the media types accepted by the subscriber
+         *
+         * @generated from field: norsk.api.media.SourceSubscriptionError.UnsupportedConversion unsupported_conversion = 5;
+         */
+        value: SourceSubscriptionError_UnsupportedConversion;
+        case: "unsupportedConversion";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+    constructor(data?: PartialMessage<SourceSubscriptionError>);
+    static readonly runtime: import("@bufbuild/protobuf/dist/types/private/proto-runtime.js").ProtoRuntime;
+    static readonly typeName = "norsk.api.media.SourceSubscriptionError";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SourceSubscriptionError;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SourceSubscriptionError;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SourceSubscriptionError;
+    static equals(a: SourceSubscriptionError | PlainMessage<SourceSubscriptionError> | undefined, b: SourceSubscriptionError | PlainMessage<SourceSubscriptionError> | undefined): boolean;
+}
+/**
+ * @generated from message norsk.api.media.SourceSubscriptionError.SourceStream
+ */
+export declare class SourceSubscriptionError_SourceStream extends Message<SourceSubscriptionError_SourceStream> {
+    /**
+     * @generated from field: norsk.api.media.MediaNodeId media_node_id = 1;
+     */
+    mediaNodeId?: MediaNodeId;
+    /**
+     * @generated from field: norsk.api.media.StreamKey stream_key = 2;
+     */
+    streamKey?: StreamKey;
+    constructor(data?: PartialMessage<SourceSubscriptionError_SourceStream>);
+    static readonly runtime: import("@bufbuild/protobuf/dist/types/private/proto-runtime.js").ProtoRuntime;
+    static readonly typeName = "norsk.api.media.SourceSubscriptionError.SourceStream";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SourceSubscriptionError_SourceStream;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SourceSubscriptionError_SourceStream;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SourceSubscriptionError_SourceStream;
+    static equals(a: SourceSubscriptionError_SourceStream | PlainMessage<SourceSubscriptionError_SourceStream> | undefined, b: SourceSubscriptionError_SourceStream | PlainMessage<SourceSubscriptionError_SourceStream> | undefined): boolean;
+}
+/**
+ * @generated from message norsk.api.media.SourceSubscriptionError.NoSubscriberPin
+ */
+export declare class SourceSubscriptionError_NoSubscriberPin extends Message<SourceSubscriptionError_NoSubscriberPin> {
+    /**
+     * @generated from field: norsk.api.media.SourceSubscriptionError.SourceStream source_stream = 1;
+     */
+    sourceStream?: SourceSubscriptionError_SourceStream;
+    /**
+     * @generated from field: string pin = 2;
+     */
+    pin: string;
+    /**
+     * @generated from field: repeated string subscriber_pins = 3;
+     */
+    subscriberPins: string[];
+    constructor(data?: PartialMessage<SourceSubscriptionError_NoSubscriberPin>);
+    static readonly runtime: import("@bufbuild/protobuf/dist/types/private/proto-runtime.js").ProtoRuntime;
+    static readonly typeName = "norsk.api.media.SourceSubscriptionError.NoSubscriberPin";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SourceSubscriptionError_NoSubscriberPin;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SourceSubscriptionError_NoSubscriberPin;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SourceSubscriptionError_NoSubscriberPin;
+    static equals(a: SourceSubscriptionError_NoSubscriberPin | PlainMessage<SourceSubscriptionError_NoSubscriberPin> | undefined, b: SourceSubscriptionError_NoSubscriberPin | PlainMessage<SourceSubscriptionError_NoSubscriberPin> | undefined): boolean;
+}
+/**
+ * @generated from message norsk.api.media.SourceSubscriptionError.UnsupportedConversion
+ */
+export declare class SourceSubscriptionError_UnsupportedConversion extends Message<SourceSubscriptionError_UnsupportedConversion> {
+    /**
+     * @generated from field: norsk.api.media.SourceSubscriptionError.SourceStream source_stream = 1;
+     */
+    sourceStream?: SourceSubscriptionError_SourceStream;
+    /**
+     * @generated from field: repeated string source_types = 2;
+     */
+    sourceTypes: string[];
+    /**
+     * @generated from field: repeated string subscriber_types = 3;
+     */
+    subscriberTypes: string[];
+    constructor(data?: PartialMessage<SourceSubscriptionError_UnsupportedConversion>);
+    static readonly runtime: import("@bufbuild/protobuf/dist/types/private/proto-runtime.js").ProtoRuntime;
+    static readonly typeName = "norsk.api.media.SourceSubscriptionError.UnsupportedConversion";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SourceSubscriptionError_UnsupportedConversion;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SourceSubscriptionError_UnsupportedConversion;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SourceSubscriptionError_UnsupportedConversion;
+    static equals(a: SourceSubscriptionError_UnsupportedConversion | PlainMessage<SourceSubscriptionError_UnsupportedConversion> | undefined, b: SourceSubscriptionError_UnsupportedConversion | PlainMessage<SourceSubscriptionError_UnsupportedConversion> | undefined): boolean;
+}
 /**
  * `Struct` represents a structured data value, consisting of fields
  * which map to dynamically typed values. In some languages, `Struct`