haishinkit/com.haishinkit.rtmp/RtmpStream

RtmpStream

class RtmpStream(context: Context, connection: RtmpConnection) : Stream, IEventDispatcher

An object that provides the interface to control a one-way channel over a RtmpConnection.

Constructors

RtmpStream

constructor(context: Context, connection: RtmpConnection)

Types

Code

enum Code : Enum<RtmpStream.Code>

Companion

object Companion

HowToPublish

enum HowToPublish : Enum<RtmpStream.HowToPublish>

Info

data class Info(var resourceName: String? = null)

Listener

interface Listener

Properties

audioSetting

val audioSetting: AudioCodec.Setting

Specifies the audio codec settings.

audioSource

var audioSource: AudioSource?

The current audio source object.

currentFPS

@Volatile

var currentFPS: Int

fcPublishName

var fcPublishName: String?

Specifies the stream name used for FMLE-compatible sequences.

info

var info: RtmpStream.Info

listener

var listener: RtmpStream.Listener?

receiveAudio

var receiveAudio: Boolean

Incoming audio plays on the stream or not.

receiveVideo

var receiveVideo: Boolean

Incoming video plays on the stream or not.

screen

val screen: Screen

The offscreen renderer for video output.

videoEffect

var videoEffect: VideoEffect?

Specifies the videoEffect such as a monochrome, a sepia.

videoSetting

val videoSetting: VideoCodec.Setting

Specifies the video codec settings.

videoSource

var videoSource: VideoSource?

The current video source object.

view

var view: StreamView?

Specifies the StreamView object.

Functions

addEventListener

open fun addEventListener(type: String, listener: IEventListener)

open override fun addEventListener(type: String, listener: IEventListener, useCapture: Boolean)

Registers the event listeners on the event target.

attachAudio

fun attachAudio(audio: AudioSource?)

Attaches an audio stream to a Stream.

attachVideo

fun attachVideo(video: VideoSource?)

Attaches a video stream to a Stream.

open override fun close()

Closes the stream from the server.

dispatchEvent

open override fun dispatchEvent(event: Event)

Dispatches the events into the implementations event model.

dispatchEventWith

open fun dispatchEventWith(type: String)

Dispatches the events into the implementations event model.

open fun dispatchEventWith(type: String, bubbles: Boolean)

open override fun dispatchEventWith(type: String, bubbles: Boolean, data: Any?)

dispose

open override fun dispose()

Disposes the stream of memory management.

play

fun play(vararg arguments: Any)

Plays a media file or a live stream from server.

publish

fun publish(name: String?, howToPublish: RtmpStream.HowToPublish = HowToPublish.LIVE)

Sends streaming audio, video and data messages from a client to server.

removeEventListener

open fun removeEventListener(type: String, listener: IEventListener)

open override fun removeEventListener(type: String, listener: IEventListener, useCapture: Boolean)

Unregister the event listeners on the event target.

send

fun send(handlerName: String, vararg arguments: Any)

Sends a message on a published stream.