tv.ustream.broadcaster.logic.publishers.FlashPublisher

	Property	Defined By
		active : Boolean [read-only]	Dispatcher
		activityLevel : Number [override] [read-only] Gets the activity level of the current audio device.	FlashPublisher
		activityLevelAvailable : Boolean [read-only] Returns true if the activity level is available	Publisher
		audioEnabled : Boolean [override] Sets the enabled state of the audio broadcasting.	FlashPublisher
		audioQualityPercent : Number [override] Sets the audio quality in percent.	FlashPublisher
		audioQualityValue : Number [read-only] Returns the audio quality.	Publisher
		broadcasting : Boolean [read-only] Returns the broadcasting state of the stream.	Publisher
		camActivity : Boolean [read-only]	FlashPublisher
		cameraName : String [override] Sets the current video device name.	FlashPublisher
		cameraNames : Array [read-only] Returns the list of available video devices.	Publisher
		canSetDevices : Boolean [read-only] Returns true, if the broadcaster is allowed set the video device.	Publisher
		canSetQuality : Boolean [read-only] Returns true, if the broadcaster is allowed set the quality of the video.	Publisher
		canSetVolume : Boolean [read-only] Returns true, if the broadcaster is allowed set the volume.	Publisher
		canSetWideScreen : Boolean [read-only]	Publisher
		fpsPercent : Number [override] Sets the fps.	FlashPublisher
		fpsValue : Number [read-only] Gets the fps value.	Publisher
		hasSources : Boolean [override] [read-only] Returns true if there is available and enabled audio or video device, or pops up the settings dialog of the Flash Player to request enabling of them.	FlashPublisher
		highResolution : Boolean	FlashPublisher
		localMonitorAvailable : Boolean [read-only] Returns true if the local monitor is available.	Publisher
		localMonitorEnabled : Boolean Sets and gets if the monitor should show the local stream.	Publisher
		microphoneName : String [override] Sets the current audio device name.	FlashPublisher
		microphoneNames : Array [read-only] Returns the list of available audio devices.	Publisher
		remoteMonitorAvailable : Boolean [read-only] Returns true, if the remote monitor is available.	Publisher
		remoteMonitorEnabled : Boolean Sets and gets if the monitor should show the encoded stream.	Publisher
		streamNamePrefix : String [static] [read-only] Generates a random prefix which will constant for this session.	Publisher
		videoEnabled : Boolean [override] Sets the enabled state of the video broadcasting.	FlashPublisher
		videoQualityPercent : Number [override] Sets the video quality in percent.	FlashPublisher
		videoQualityValue : Number [read-only] Returns the video quality.	Publisher
		volume : Number [override] Sets the volume	FlashPublisher
		wideScreen : Boolean [override]	FlashPublisher

Property

Defined By

active : Boolean

[read-only]

Dispatcher

activityLevel : Number

[override] [read-only] Gets the activity level of the current audio device.

FlashPublisher

activityLevelAvailable : Boolean

[read-only] Returns true if the activity level is available

Publisher

audioEnabled : Boolean

[override] Sets the enabled state of the audio broadcasting.

FlashPublisher

audioQualityPercent : Number

[override] Sets the audio quality in percent.

FlashPublisher

audioQualityValue : Number

[read-only] Returns the audio quality.

Publisher

broadcasting : Boolean

[read-only] Returns the broadcasting state of the stream.

Publisher

camActivity : Boolean

[read-only]

FlashPublisher

cameraName : String

[override] Sets the current video device name.

FlashPublisher

cameraNames : Array

[read-only] Returns the list of available video devices.

Publisher

canSetDevices : Boolean

[read-only] Returns true, if the broadcaster is allowed set the video device.

Publisher

canSetQuality : Boolean

[read-only] Returns true, if the broadcaster is allowed set the quality of the video.

Publisher

canSetVolume : Boolean

[read-only] Returns true, if the broadcaster is allowed set the volume.

Publisher

canSetWideScreen : Boolean

[read-only]

Publisher

fpsPercent : Number

[override] Sets the fps.

FlashPublisher

fpsValue : Number

[read-only] Gets the fps value.

Publisher

hasSources : Boolean

[override] [read-only] Returns true if there is available and enabled audio or video device, or pops up the settings dialog of the Flash Player to request enabling of them.

FlashPublisher

highResolution : Boolean

FlashPublisher

localMonitorAvailable : Boolean

[read-only] Returns true if the local monitor is available.

Publisher

localMonitorEnabled : Boolean

Sets and gets if the monitor should show the local stream.

Publisher

microphoneName : String

[override] Sets the current audio device name.

FlashPublisher

microphoneNames : Array

[read-only] Returns the list of available audio devices.

Publisher

remoteMonitorAvailable : Boolean

[read-only] Returns true, if the remote monitor is available.

Publisher

remoteMonitorEnabled : Boolean

Sets and gets if the monitor should show the encoded stream.

Publisher

streamNamePrefix : String

[static] [read-only] Generates a random prefix which will constant for this session.

Publisher

videoEnabled : Boolean

[override] Sets the enabled state of the video broadcasting.

FlashPublisher

videoQualityPercent : Number

[override] Sets the video quality in percent.

FlashPublisher

videoQualityValue : Number

[read-only] Returns the video quality.

Publisher

volume : Number

[override] Sets the volume

FlashPublisher

wideScreen : Boolean

[override]

FlashPublisher

	Property	Defined By
		_active : Boolean = true	Dispatcher

Property

Defined By

_active : Boolean = true

Dispatcher

	Method	Defined By
		FlashPublisher(logic:Logic, fms:Connection) Constructor.	FlashPublisher
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]	Dispatcher
		audioQualityFormat(percent:Number = 0):String [override] Formats the percent value of the audio quality to a more user friendly format.	FlashPublisher
		destroy(... e):* [override] Clean up method	FlashPublisher
		dispatchEvent(event:Event):Boolean [override]	Dispatcher
		eliminateEventListeners():void	Dispatcher
		fpsFormat(percent:Number = 0):String Formats the percent value of the fps to a more user friendly format.	Publisher
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]	Dispatcher
		setEchoPrefix(str:String):void	Dispatcher
		startBroadcast():void [override] Starts the broadcast.	FlashPublisher
		stopBroadcast():void [override] Stops the broadcast.	FlashPublisher
		videoQualityFormat(percent:Number = 0):String Formats the percent value of the video quality to a more user friendly format.	Publisher

Method

Defined By

FlashPublisher(logic:Logic, fms:Connection)

Constructor.

FlashPublisher

addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

[override]

Dispatcher

audioQualityFormat(percent:Number = 0):String

[override] Formats the percent value of the audio quality to a more user friendly format.

FlashPublisher

destroy(... e):*

[override] Clean up method

FlashPublisher

dispatchEvent(event:Event):Boolean

[override]

Dispatcher

eliminateEventListeners():void

Dispatcher

fpsFormat(percent:Number = 0):String

Formats the percent value of the fps to a more user friendly format.

Publisher

removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

[override]

Dispatcher

setEchoPrefix(str:String):void

Dispatcher

startBroadcast():void

[override] Starts the broadcast.

FlashPublisher

stopBroadcast():void

[override] Stops the broadcast.

FlashPublisher

videoQualityFormat(percent:Number = 0):String

Formats the percent value of the video quality to a more user friendly format.

Publisher

	Method	Defined By
		dispatch(eventName:String, bubbles:Boolean = false, data:* = null):void Dispatches the event, if the class is active.	Dispatcher
		echo(what:String):void	Dispatcher
		fmeConnected(streamName:String = null, online:Boolean = false, serverUrl:String = null, forced:Boolean = false):void [override] Fires an event when an Adobe Flash Media Live Encoder connected to the channel.	FlashPublisher
		fmeRedirect(params:Object):void	FlashPublisher
		init():void [override] Init method.	FlashPublisher
		onBroadcastStarted(... e):void [override]	FlashPublisher

Method

Defined By

dispatch(eventName:String, bubbles:Boolean = false, data:* = null):void

Dispatches the event, if the class is active.

Dispatcher

echo(what:String):void

Dispatcher

fmeConnected(streamName:String = null, online:Boolean = false, serverUrl:String = null, forced:Boolean = false):void

[override] Fires an event when an Adobe Flash Media Live Encoder connected to the channel.

FlashPublisher

fmeRedirect(params:Object):void

FlashPublisher

init():void

[override] Init method.

FlashPublisher

onBroadcastStarted(... e):void

[override]

FlashPublisher

Summary	Defined By
cameraName	Fires when the broadcaster changes the selected video device.	Publisher
destroy		Dispatcher
localMonitor	Fires when the local stream selected as monitor.	Publisher
localMonitorAvailable		FlashPublisher
microphoneName	Fires when the broadcaster changes the selected audio device.	Publisher
remoteMonitor	Fires, when the server stream selected as monitor	Publisher
remoteMonitorAvailable		FlashPublisher

Event

Summary

Defined By

cameraName

Fires when the broadcaster changes the selected video device.

Fires when the local stream selected as monitor.

Publisher

localMonitorAvailable

FlashPublisher

microphoneName

Fires when the broadcaster changes the selected audio device.

Publisher

remoteMonitor

Fires, when the server stream selected as monitor

Publisher

remoteMonitorAvailable

FlashPublisher

Property Detail

activityLevel

property

activityLevel:Number [read-only] [override]

Gets the activity level of the current audio device.

Implementation
public function get activityLevel():Number

audioEnabled

property

audioEnabled:Boolean[override]

Sets the enabled state of the audio broadcasting.

Implementation
public function get audioEnabled():Boolean
public function set audioEnabled(value:Boolean):void

audioQualityPercent

property

audioQualityPercent:Number[override]

Sets the audio quality in percent.

Implementation
public function get audioQualityPercent():Number
public function set audioQualityPercent(value:Number):void

camActivity

property

camActivity:Boolean [read-only]

Implementation
public function get camActivity():Boolean

cameraName

property

cameraName:String[override]

Sets the current video device name.

Implementation
public function get cameraName():String
public function set cameraName(value:String):void

fpsPercent

property

fpsPercent:Number[override]

Sets the fps.

Implementation
public function get fpsPercent():Number
public function set fpsPercent(value:Number):void

hasSources

property

hasSources:Boolean [read-only] [override]

Returns true if there is available and enabled audio or video device, or pops up the settings dialog of the Flash Player to request enabling of them.

Implementation
public function get hasSources():Boolean

highResolution

property

highResolution:Boolean

Implementation
public function get highResolution():Boolean
public function set highResolution(value:Boolean):void

microphoneName

property

microphoneName:String[override]

Sets the current audio device name.

Implementation
public function get microphoneName():String
public function set microphoneName(value:String):void

videoEnabled

property

videoEnabled:Boolean[override]

Sets the enabled state of the video broadcasting.

Implementation
public function get videoEnabled():Boolean
public function set videoEnabled(value:Boolean):void

videoQualityPercent

property

videoQualityPercent:Number[override]

Sets the video quality in percent.

Implementation
public function get videoQualityPercent():Number
public function set videoQualityPercent(value:Number):void

volume

property

volume:Number[override]

Sets the volume

Implementation
public function get volume():Number
public function set volume(value:Number):void

wideScreen

property

wideScreen:Boolean[override]

Implementation
public function get wideScreen():Boolean
public function set wideScreen(value:Boolean):void

Constructor Detail

FlashPublisher

()

Constructor

public function FlashPublisher(logic:Logic, fms:Connection)

Constructor.

Parameters

	`logic:Logic`

	`fms:Connection`

Method Detail

audioQualityFormat

()

method

override public function audioQualityFormat(percent:Number = 0):String

Formats the percent value of the audio quality to a more user friendly format.

Parameters

percent:Number (default = 0)

Returns

String —

destroy

()

method

override public function destroy(... e):*

Clean up method

Parameters

... e

Returns

* —

fmeConnected

()

method

override protected function fmeConnected(streamName:String = null, online:Boolean = false, serverUrl:String = null, forced:Boolean = false):void

Fires an event when an Adobe Flash Media Live Encoder connected to the channel.

Parameters

	`streamName:String` (default = `null`)

	`online:Boolean` (default = `false`) — online

	`serverUrl:String` (default = `null`)

	`forced:Boolean` (default = `false`)

fmeRedirect

()

method

protected function fmeRedirect(params:Object):void

Parameters

params:Object

init

()

method

override protected function init():void

Init method. Gets the available cameras and microphones, sets the ones saved in the SharedObject. Sets the enabled state of video and audio on FMS.

onBroadcastStarted

()

method

override protected function onBroadcastStarted(... e):void

Parameters

... e

startBroadcast

()

method

override public function startBroadcast():void

Starts the broadcast.

stopBroadcast

()

method

override public function stopBroadcast():void

Stops the broadcast.

Event Detail

localMonitorAvailable

Event

Event Object Type: flash.events.Event

remoteMonitorAvailable

Event

Event Object Type: flash.events.Event

Fri Apr 1 2011, 11:43 AM +02:00

Ustream Runtime Shared Library	All Packages \| All Classes \| Index \| Frames No Frames
FlashPublisher	Properties \| Methods \| Events

Package	tv.ustream.broadcaster.logic.publishers
Class	public class FlashPublisher
Inheritance	FlashPublisher Publisher Dispatcher flash.events.EventDispatcher