vtt_cue.h

Go to the documentation of this file.

// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SHAKA_EMBEDDED_MEDIA_VTT_CUE_H_
#define SHAKA_EMBEDDED_MEDIA_VTT_CUE_H_

#include <mutex>
#include <string>

#include "../macros.h"

namespace shaka {
namespace media {

enum class DirectionSetting : uint8_t {
  Horizontal,

  LeftToRight,

  RightToLeft,
};

enum class LineAlignSetting : uint8_t {
  Start,

  Center,

  End,
};

enum class PositionAlignSetting : uint8_t {
  LineLeft,

  Center,

  LineRight,

  Auto,
};

enum class AlignSetting : uint8_t {
  Start,

  Center,

  End,

  Left,

  Right,
};


class SHAKA_EXPORT VTTCue {
 public:
  VTTCue(double start_time, double end_time, const std::string& text);
  VTTCue(const VTTCue& cue);
  VTTCue(VTTCue&& cue);
  ~VTTCue();

  VTTCue& operator=(const VTTCue& cue);
  VTTCue& operator=(VTTCue&& cue);

  std::string id() const;
  void SetId(const std::string& id);
  double start_time() const;
  void SetStartTime(double time);
  double end_time() const;
  void SetEndTime(double time);
  bool pause_on_exit() const;
  void SetPauseOnExit(bool pause);

  DirectionSetting vertical() const;
  void SetVertical(DirectionSetting setting);
  bool snap_to_lines() const;
  void SetSnapToLines(bool snap);
  LineAlignSetting line_align() const;
  void SetLineAlign(LineAlignSetting align);
  double line() const;
  void SetLine(double line);
  double position() const;
  void SetPosition(double position);
  PositionAlignSetting position_align() const;
  void SetPositionAlign(PositionAlignSetting align);
  double size() const;
  void SetSize(double size);
  AlignSetting align() const;
  void SetAlign(AlignSetting align);
  std::string text() const;
  void SetText(const std::string& text);

 private:
  mutable std::mutex mutex_;

  std::string id_;
  std::string text_;
  double start_time_;
  double end_time_;
  double line_;
  double position_;
  double size_;
  DirectionSetting vertical_;
  LineAlignSetting line_align_;
  PositionAlignSetting position_align_;
  AlignSetting align_;
  bool snap_to_lines_;
  bool pause_on_exit_;
};

}  // namespace media
}  // namespace shaka

#endif  // SHAKA_EMBEDDED_VTT_CUE_H_