Class Bitrate

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Bitrate
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-19T12:54:55.618Z") @Stability(Stable) public class Bitrate extends software.amazon.jsii.JsiiObject
Represents a bitrate value.

The amount can be specified either as a literal value (e.g: 10) which cannot be negative, or as an unresolved number token.

When the amount is passed as a token, unit conversion is not possible.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 Bitrate bitrate = Bitrate.bps(123);
 
  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Bitrate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    Bitrate(software.amazon.jsii.JsiiObjectRef objRef)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static Bitrate
    bps(Number amount)
    Create a Bitrate representing an amount of bits per second.
    static Bitrate
    gbps(Number amount)
    Create a Bitrate representing an amount of gigabits per second.
    Checks if bitrate is a token or a resolvable object.
    static Bitrate
    kbps(Number amount)
    Create a Bitrate representing an amount of kilobits per second.
    static Bitrate
    mbps(Number amount)
    Create a Bitrate representing an amount of megabits per second.
    Return the total number of bits per second.
    Return the total number of gigabits per second.
    Return the total number of kilobits per second.
    Return the total number of megabits per second.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • Constructor Details

    • Bitrate

      protected Bitrate(software.amazon.jsii.JsiiObjectRef objRef)
    • Bitrate

      protected Bitrate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
  • Method Details

    • bps

      @Stability(Stable) @NotNull public static Bitrate bps(@NotNull Number amount)
      Create a Bitrate representing an amount of bits per second.

      Parameters:
      amount - the amount of bits per second. This parameter is required.
    • gbps

      @Stability(Stable) @NotNull public static Bitrate gbps(@NotNull Number amount)
      Create a Bitrate representing an amount of gigabits per second.

      Parameters:
      amount - the amount of gigabits per second. This parameter is required.
    • kbps

      @Stability(Stable) @NotNull public static Bitrate kbps(@NotNull Number amount)
      Create a Bitrate representing an amount of kilobits per second.

      Parameters:
      amount - the amount of kilobits per second. This parameter is required.
    • mbps

      @Stability(Stable) @NotNull public static Bitrate mbps(@NotNull Number amount)
      Create a Bitrate representing an amount of megabits per second.

      Parameters:
      amount - the amount of megabits per second. This parameter is required.
    • isUnresolved

      @Stability(Stable) @NotNull public Boolean isUnresolved()
      Checks if bitrate is a token or a resolvable object.
    • toBps

      @Stability(Stable) @NotNull public Number toBps()
      Return the total number of bits per second.
    • toGbps

      @Stability(Stable) @NotNull public Number toGbps()
      Return the total number of gigabits per second.
    • toKbps

      @Stability(Stable) @NotNull public Number toKbps()
      Return the total number of kilobits per second.
    • toMbps

      @Stability(Stable) @NotNull public Number toMbps()
      Return the total number of megabits per second.