syntax = "proto3";

package tv.make.api;

option go_package = "git.ltnglobal.com/make.tv/genproto/api;api";

import "google/api/field_behavior.proto";

message Slate {
  enum Status {
    STATUS_UNSPECIFIED = 0;
    // Slate is in unknown state.
    UNKNOWN = 1;
    // Slate is being prepared.
    PREPARING = 2;
    // Slate is downloaded and ready to use.
    READY = 3;
    // Slate is unavailable due to some error.
    ERROR = 4;
  }

  // The unique identifier of the slate.
  string id = 1;

  // URL of the the slate.
  string url = 2 [(google.api.field_behavior) = REQUIRED];

  // Level of the slate audio signal.
  //
  // example:
  // 0.0 - silence signal
  // 1.0 - audio component of the signal is not changed
  // default: 0.0
  double audio_level = 3 [(google.api.field_behavior) = REQUIRED];

  // Availability status of the slate.
  Status status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Whether or not the slate is shown.
  bool is_active = 5 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Whether or not the slate should be looped.
  bool loop = 6 [(google.api.field_behavior) = REQUIRED];
}