AWS CDK Reference

Appearance

v2.274.0

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

RtmpDestination Class ​

A destination for an RTMP output group.

Use the static factory methods to create.

Stability
Experimental
Source
lib/destinations.ts

Example ​

ts
declare const video: medialive.EncodeConfiguration;
declare const audio: medialive.EncodeConfiguration;

medialive.OutputGroupConfiguration.rtmp({
  name: 'social',
  outputs: [{
    encodes: [video, audio],
    outputName: 'live',
    destinations: [
      medialive.RtmpDestination.url('rtmp://rtmp.example.com/live', 'your-stream-key'),
    ],
  }],
});

Initializer ​

ts
new RtmpDestination()
python
RtmpDestination()
java
new RtmpDestination()
csharp
new RtmpDestination()
go
NewRtmpDestination()

Methods ​

url(url: string, streamName: string, options?: OutputDestinationOptions): RtmpDestination // chainable@staticmethod def url(url: str, stream_name: str, options: typing.Optional[OutputDestinationOptions] = None) -> RtmpDestinationpublic static RtmpDestination url(String url, String streamName, OutputDestinationOptions options)public static RtmpDestination Url(string url, string streamName, OutputDestinationOptions? options = null)func Url(Url *string, StreamName *string, Options OutputDestinationOptions) RtmpDestinationstatic#
Create an RTMP destination.
3 parameters

Parameters

  • urlurlurlurlUrl — The RTMP endpoint URL (e.g. rtmp://host/appname).
  • streamNamestream_namestreamNamestreamNameStreamName — The stream name (stream key).
  • optionsoptionsoptionsoptionsOptions — Optional credentials.