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'),
],
}],
});
python
# video: medialive.EncodeConfiguration
# audio: medialive.EncodeConfiguration
medialive.OutputGroupConfiguration.rtmp(
name="social",
outputs=[medialive.RtmpOutputDefinition(
encodes=[video, audio],
output_name="live",
destinations=[
medialive.RtmpDestination.url("rtmp://rtmp.example.com/live", "your-stream-key")
]
)]
)
java
EncodeConfiguration video;
EncodeConfiguration audio;
OutputGroupConfiguration.rtmp(RtmpOutputGroupProps.builder()
.name("social")
.outputs(List.of(RtmpOutputDefinition.builder()
.encodes(List.of(video, audio))
.outputName("live")
.destinations(List.of(RtmpDestination.url("rtmp://rtmp.example.com/live", "your-stream-key")))
.build()))
.build());
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaLive.Alpha
EncodeConfiguration video;
EncodeConfiguration audio;
OutputGroupConfiguration.Rtmp(new RtmpOutputGroupProps {
Name = "social",
Outputs = new [] { new RtmpOutputDefinition {
Encodes = new [] { video, audio },
OutputName = "live",
Destinations = new [] { RtmpDestination.Url("rtmp://rtmp.example.com/live", "your-stream-key") }
} }
});
go
// Install: go get github.com/aws/aws-cdk-go/awsmedialivealpha/v2
var video EncodeConfiguration
var audio EncodeConfiguration
medialive.OutputGroupConfiguration_Rtmp(&RtmpOutputGroupProps{
Name: jsii.String("social"),
Outputs: []RtmpOutputDefinition{
&RtmpOutputDefinition{
Encodes: []EncodeConfiguration{
video,
audio,
},
OutputName: jsii.String("live"),
Destinations: []RtmpDestination{
medialive.RtmpDestination_Url(jsii.String("rtmp://rtmp.example.com/live"), jsii.String("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) RtmpDestination static #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.