Class: Bitmovin::EncodingProfile

Inherits:

Object

Object
Bitmovin::EncodingProfile

show all

Extended by:: Helpers

Includes:: Helpers

Defined in:: lib/bitmovin/encoding_profile.rb

Overview

Represents a bitmovin encoding profile

Constant Summary collapse

ATTRIBUTES =

%i{
  encoding_profile_id
  video_stream_configs
  audio_stream_configs
  watermark_config
  created_at
  type
  name
}

Constants included from Helpers

Helpers::S3_BUCKET_IN_URL_REGEX, Helpers::S3_BUCKET_SUBDOMAIN_REGEX, Helpers::S3_OBJECT_KEY_IN_URL_REGEX, Helpers::S3_OBJECT_KEY_SUBDOMAIN_REGEX

Class Method Summary collapse

.create(params = {}) ⇒ Object
- :name Name of new Encoding profile * :rotation Rotation of the video in degrees.
.list(page = 1) ⇒ Array<Bitmovin::EncodingProfile>

Get list of available encoding profiles by pages per 10.

Instance Method Summary collapse

#create ⇒ Object

Create encoding profile with params given within initialization.
#details(reload = false) ⇒ Hash

Get encoding profile details as hash.
#initialize(params = {}) ⇒ EncodingProfile constructor
- :name Name of new Encoding profile * :rotation Rotation of the video in degrees.

Methods included from Helpers

deep_camelize_keys, deep_underscore_keys, extract_bucket, extract_object_key, prepare_request_json, prepare_response_json

Constructor Details

#initialize(params = {}) ⇒ `EncodingProfile`

:name Name of new Encoding profile
:rotation Rotation of the video in degrees. A positive value will rotate the video clockwise and a negative one counter clockwise.
:segment_length Only available using standard speed. Defines the length of a segment. Must be a value between 1 and 9 seconds.
:video_stream_configs An array of video profile configs
- :default_stream_id ID of the video stream which should be encoded
- :representation_id ID of the video stream config
- :bitrate Bitrate of the video stream. Value must be in the range from 32000 to 20000000
- :profile Profile which should be used to encode video stream. Possible values are: baseline, main, high
- :preset Preset which should be used to encode video stream. Possible values are: standard, professional, premium
- :height Video-Width in px, must be in the range from 128 to 7680
- :width Video-Height in px, must be in the range from 96 to 4320
- :rate Only available using standard speed. The sample rate the encoded video should have in FPS. Values must be in the range from 1 to 120
- :codec Only available using premium speed. Sets the video codec used for encoding. Possible values are: h264, hevc. Default value is h264.
- :b_frames Sets the amount of B-Frames. Valid value range: 0 - 16
- :ref_frames Sets the amount of Reference-Frames. Valid value range: 0 - 16
- :qp_min Sets the minimum of quantization-factor. Valid value range: 0 - 69
- :qp_max Sets the maximum of quantization-factor. Valid value range: 0 - 69
- :mv_prediction_mode Sets the Motion Vector Prediction Mode. Valid values: none, spatial, temporal, auto
- :mv_search_range_max Sets the maximum Motion-Vector-Search-Range. Valid value range: 16 - 24
- :no_cabac Disable CABAC.
:audio_stream_configs An array of audio profile configs
- :default_stream_id ID of the audio stream which should be encoded
- :representation_id ID of the audio stream config
- :bitrate Bitrate of the audio stream. Values must be in the range from 8000 to 256000
- :rate The sample rate the encoded audio should have in Hz. Possible values are: 0, 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000
:watermark_config A watermark config
- :top Distance between the top of the watermark image and the top of the input video
- :left Distance between the left side of the watermark image and the left side of the input video
- :bottom Distance between the bottom of the watermark image and the bottom of the input video
- :right Distance between the right of the watermark image and the right of the input video
:cropping_config
- :top Amount of pixel which will be cropped of the input video from the top.
- :left Amount of pixel which will be cropped of the input video from the left side.
- :bottom Amount of pixel which will be cropped of the input video from the bottom.
- :right Amount of pixel which will be cropped of the input video from the right side.

Parameters:

params (defaults to: {}) —

Encoding profile video & audio configurations



70
71
72

# File 'lib/bitmovin/encoding_profile.rb', line 70

def initialize(params={})
  @details = params
end

Class Method Details

.create(params = {}) ⇒ `Object`

:name Name of new Encoding profile
:rotation Rotation of the video in degrees. A positive value will rotate the video clockwise and a negative one counter clockwise.
:segment_length Only available using standard speed. Defines the length of a segment. Must be a value between 1 and 9 seconds.
:video_stream_configs An array of video profile configs
- :default_stream_id ID of the video stream which should be encoded
- :representation_id ID of the video stream config
- :bitrate Bitrate of the video stream. Value must be in the range from 32000 to 20000000
- :profile Profile which should be used to encode video stream. Possible values are: baseline, main, high
- :preset Preset which should be used to encode video stream. Possible values are: standard, professional, premium
- :height Video-Width in px, must be in the range from 128 to 7680
- :width Video-Height in px, must be in the range from 96 to 4320
- :rate Only available using standard speed. The sample rate the encoded video should have in FPS. Values must be in the range from 1 to 120
- :codec Only available using premium speed. Sets the video codec used for encoding. Possible values are: h264, hevc. Default value is h264.
- :b_frames Sets the amount of B-Frames. Valid value range: 0 - 16
- :ref_frames Sets the amount of Reference-Frames. Valid value range: 0 - 16
- :qp_min Sets the minimum of quantization-factor. Valid value range: 0 - 69
- :qp_max Sets the maximum of quantization-factor. Valid value range: 0 - 69
- :mv_prediction_mode Sets the Motion Vector Prediction Mode. Valid values: none, spatial, temporal, auto
- :mv_search_range_max Sets the maximum Motion-Vector-Search-Range. Valid value range: 16 - 24
- :no_cabac Disable CABAC.
:audio_stream_configs An array of audio profile configs
- :default_stream_id ID of the audio stream which should be encoded
- :representation_id ID of the audio stream config
- :bitrate Bitrate of the audio stream. Values must be in the range from 8000 to 256000
- :rate The sample rate the encoded audio should have in Hz. Possible values are: 0, 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000
:watermark_config A watermark config
- :top Distance between the top of the watermark image and the top of the input video
- :left Distance between the left side of the watermark image and the left side of the input video
- :bottom Distance between the bottom of the watermark image and the bottom of the input video
- :right Distance between the right of the watermark image and the right of the input video
:cropping_config
- :top Amount of pixel which will be cropped of the input video from the top.
- :left Amount of pixel which will be cropped of the input video from the left side.
- :bottom Amount of pixel which will be cropped of the input video from the bottom.
- :right Amount of pixel which will be cropped of the input video from the right side.

Parameters:

params (defaults to: {}) —

Encoding profile video & audio configurations



121
122
123

# File 'lib/bitmovin/encoding_profile.rb', line 121

def self.create(params={})
  new(params).create
end

.list(page = 1) ⇒ `Array<Bitmovin::EncodingProfile>`

Get list of available encoding profiles by pages per 10

Parameters:

page (Integer) (defaults to: 1) —

number of page

Returns:

(Array<Bitmovin::EncodingProfile>) —

array of encoding profiles

# File 'lib/bitmovin/encoding_profile.rb', line 144

def list(page = 1)
  get = Net::HTTP::Get.new "/api/encoding-profiles/#{page}", initheaders = headers

  response = Bitmovin.http.request get

  json = prepare_response_json(response.body)

  json[:profiles].map { |p| Bitmovin::EncodingProfile.new(p) }
end

Instance Method Details

#create ⇒ `Object`

Create encoding profile with params given within initialization

return [Bitmovin::EncodingProfile] create bitmovin encoding profile

# File 'lib/bitmovin/encoding_profile.rb', line 78

def create
  make_create_request
  self
end

#details(reload = false) ⇒ `Hash`

Get encoding profile details as hash

Parameters:

reload (Boolean) (defaults to: false) —

Reload details from server

Returns:

(Hash) —

encoding profile details

# File 'lib/bitmovin/encoding_profile.rb', line 130

def details(reload = false)
  return @details unless reload

  reload_details
end

Class: Bitmovin::EncodingProfile

Overview

Constant Summary collapse

Constants included from Helpers

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helpers

Constructor Details

#initialize(params = {}) ⇒ EncodingProfile

Class Method Details

.create(params = {}) ⇒ Object

.list(page = 1) ⇒ Array<Bitmovin::EncodingProfile>

Instance Method Details

#create ⇒ Object

#details(reload = false) ⇒ Hash

#initialize(params = {}) ⇒ `EncodingProfile`

.create(params = {}) ⇒ `Object`

.list(page = 1) ⇒ `Array<Bitmovin::EncodingProfile>`

#create ⇒ `Object`

#details(reload = false) ⇒ `Hash`