Package com.opentok.android

Class Publisher

java.lang.Object

com.opentok.android.PublisherKit

com.opentok.android.Publisher

All Implemented Interfaces:

java.util.Observer

public class Publisher
extends PublisherKit

Used to capture an audio-video stream from the device's microphone and camera for use in an OpenTok session. Create a Publisher instance by calling the Publisher constructor.

When the view of a Publisher leaves the active window, the Publisher object is destroyed. This is the case for an activity that is stopped or paused.

See Also:

Session.publish(PublisherKit publisher)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Publisher.Builder	Used to build a Publisher object.
static class	Publisher.CameraCaptureFrameRate	Defines values for the frameRate parameter of the Publisher.Builder.frameRate(Publisher.CameraCaptureFrameRate frameRate) method.
static class	Publisher.CameraCaptureResolution	Defines values for the resolution parameter of the Publisher.Builder.resolution(Publisher.CameraCaptureResolution resolution) method.
static interface	Publisher.CameraListener	Monitors when the camera used by the publisher changes.

Nested classes/interfaces inherited from class com.opentok.android.PublisherKit

PublisherKit.AudioLevelListener, PublisherKit.AudioStatsListener, PublisherKit.AudioTransformer, PublisherKit.CustomAudioTransformer, PublisherKit.CustomVideoTransformer, PublisherKit.MuteListener, PublisherKit.PublisherAudioStats, PublisherKit.PublisherKitVideoType, PublisherKit.PublisherListener, PublisherKit.PublisherRtcStats, PublisherKit.PublisherRtcStatsReportListener, PublisherKit.PublisherVideoStats, PublisherKit.VideoListener, PublisherKit.VideoStatsListener, PublisherKit.VideoTransformer

Field Summary

Fields

Modifier and Type	Field	Description
protected Publisher.CameraCaptureFrameRate	cameraFrameRate
protected Publisher.CameraListener	cameraListener
protected Publisher.CameraCaptureResolution	cameraResolution

Fields inherited from class com.opentok.android.PublisherKit

audioLevelListener, audioStatsListener, capturer, context, handler, muteListener, publisherListener, renderer, rtcStatsReportListener, videoListener, videoStatsListener

Constructor Summary

Constructors

Modifier	Constructor	Description
	Publisher(android.content.Context context)	Deprecated.
	Publisher(android.content.Context context, java.lang.String name)	Deprecated.
	Publisher(android.content.Context context, java.lang.String name, boolean audioTrack, boolean videoTrack)	Deprecated.
protected	Publisher(android.content.Context context, java.lang.String name, boolean audioTrack, boolean videoTrack, BaseVideoCapturer capturer, Publisher.CameraCaptureResolution resolution, Publisher.CameraCaptureFrameRate frameRate, BaseVideoRenderer renderer)	Deprecated.
protected	Publisher(android.content.Context context, java.lang.String name, boolean audioTrack, int maxAudioBitrate, boolean videoTrack, BaseVideoCapturer capturer, Publisher.CameraCaptureResolution resolution, Publisher.CameraCaptureFrameRate frameRate, BaseVideoRenderer renderer, boolean enableOpusDtx, boolean scalableScreenshare)	Deprecated.
protected	Publisher(android.content.Context context, java.lang.String name, boolean audioTrack, int maxAudioBitrate, boolean videoTrack, BaseVideoCapturer capturer, Publisher.CameraCaptureResolution resolution, Publisher.CameraCaptureFrameRate frameRate, BaseVideoRenderer renderer, boolean enableOpusDtx, boolean scalableScreenshare, boolean subscriberAudioFallback, boolean publisherAudioFallback)	Creates a new Publisher object.
	Publisher(android.content.Context context, java.lang.String name, BaseVideoCapturer capturer)	Deprecated.
	Publisher(android.content.Context context, java.lang.String name, Publisher.CameraCaptureResolution resolution, Publisher.CameraCaptureFrameRate frameRate)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	cycleCamera()	Cycles between cameras, if there are multiple cameras on the device.
int	getCameraId()	Deprecated.
protected void	onCameraChanged(int newCameraId)	Invoked when the publisher changes the active camera.
protected void	onCameraError(OpentokError error)	Invoked when there is an error accessing the camera.
void	setCameraId(int cameraId)	Deprecated.
void	setCameraListener(Publisher.CameraListener listener)	Sets a Publisher.CameraListener object to monitor when the camera used by the publisher changes.
void	startPreview()	Deprecated.
void	swapCamera()	Deprecated.

Methods inherited from class com.opentok.android.PublisherKit

destroy, finalize, getAudioFallbackEnabled, getCapturer, getName, getPublishAudio, getPublishCaptions, getPublisherVideoType, getPublishVideo, getRenderer, getRtcStatsReport, getSession, getStream, getView, onAudioLevelUpdated, onError, onMuteForced, onPause, onRestart, onResume, onRtcStatsReport, onStop, onStreamCreated, onStreamDestroyed, setAudioFallbackEnabled, setAudioLevelListener, setAudioStatsListener, setAudioTransformers, setCapturer, setMuteListener, setName, setPublishAudio, setPublishCaptions, setPublisherListener, setPublisherVideoType, setPublishVideo, setRenderer, setRtcStatsReportListener, setStyle, setVideoListener, setVideoStatsListener, setVideoTransformers, update

Methods inherited from class java.lang.Object

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

Field Detail

cameraFrameRate

protected Publisher.CameraCaptureFrameRate cameraFrameRate

cameraResolution

protected Publisher.CameraCaptureResolution cameraResolution

cameraListener

protected Publisher.CameraListener cameraListener

Constructor Detail

Publisher

@Deprecated
public Publisher(android.content.Context context)

Deprecated.

Creates a new Publisher instance. Use the Session.publish(PublisherKit publisher) method to start streaming from this Publisher into a session.

The PublisherKit.getView() method returns the android.view.View object containing the published video.

Parameters:

context - The android.content.Context for the Publisher.

Publisher

@Deprecated
public Publisher(android.content.Context context,
                 java.lang.String name)

Deprecated.

Creates a new Publisher instance. This method is deprecated. Use the Publisher.Builder class to instantiate a Publisher object.

Use the Session.publish(PublisherKit publisher) method to start streaming from this Publisher into a session.

This version of the constructor lets you add a name for the publisher's stream.

The PublisherKit.getView() method returns the android.view.View object containing the published video.

Parameters:

context - The android.content.Context for the Publisher.

name - The name of the publisher video. The name property for a stream published by this publisher will be set to this value (on all clients).

Publisher

@Deprecated
public Publisher(android.content.Context context,
                 java.lang.String name,
                 BaseVideoCapturer capturer)

Deprecated.

Creates a new Publisher instance. This method is deprecated. Use the Publisher.Builder class to instantiate a PublisherKit object.

Use the Session.publish(PublisherKit publisher) method to start streaming from this Publisher into a session.

This version of the constructor lets you define a custom video capturer for the Publisher.

The PublisherKit.getView() method returns the android.view.View object containing the published video.

Parameters:

context - The android.content.Context for the Publisher.

name - The name of the publisher video. The Stream.getName() method for a stream published by this publisher will return this value (on all clients).

capturer - The video capturer to use for the Publisher.

Publisher

@Deprecated
public Publisher(android.content.Context context,
                 java.lang.String name,
                 boolean audioTrack,
                 boolean videoTrack)

Deprecated.

Creates a new Publisher instance. This method is deprecated. Use the Publisher.Builder class to instantiate a PublisherKit object.

Use the Session.publish(PublisherKit publisher) method to start streaming from this Publisher into a session.

This version of the constructor adds parameters that let you exclude the audio track or video track from the published stream. Creating a Publisher without an audio track or video track can save CPU resources.

The PublisherKit.getView() method returns the android.view.View object containing the published video.

Parameters:

context - The android.content.Context for the Publisher.

name - The name of the publisher video. The Stream.getName() method for a stream published by this publisher will return this value (on all clients).

audioTrack - Whether to include an audio track in the published stream.

videoTrack - Whether to include a video track in the published stream.

Publisher

@Deprecated
public Publisher(android.content.Context context,
                 java.lang.String name,
                 Publisher.CameraCaptureResolution resolution,
                 Publisher.CameraCaptureFrameRate frameRate)

Deprecated.

Creates a new Publisher instance. This method is deprecated. Use the Publisher.Builder class to instantiate a PublisherKit object.

Use the Session.publish(PublisherKit publisher) method to start streaming from this Publisher into a session.

This version of the constructor adds parameters for setting the resolution and frame rate of the video.

For sessions that use the OpenTok Media Router (sessions with the media mode set to routed), lowering the frame rate or lowering the resolution reduces the maximum bandwidth the stream can use. However, in sessions with the media mode set to relayed, lowering the frame rate or resolution may not reduce the stream's bandwidth.

The PublisherKit.getView() method returns the android.view.View object containing the published video.

Note: The default frame rate and resolution for a Publisher constructed using other versions of the Publisher constructor are set to Publisher.CameraCaptureFrameRate.FPS_30 and Publisher.CameraCaptureResolution.MEDIUM. However, these can vary over time for the stream.

Parameters:

context - The android.content.Context for the Publisher.

name - The name of the publisher video. The Stream.getName() method for a stream published by this publisher will return this value (on all clients).

resolution - The resolution of the video. Set this to a value defined in the Publisher.CameraCaptureResolution enum.

frameRate - The frame rate of the video. Set this to a value defined in the Publisher.CameraCaptureFrameRate enum. If the device does not support the specified frame rate, it will use the closest supported frame rate that is lower. Note that in sessions that use the OpenTok Media Router (sessions with the media mode set to routed), lowering the frame rate proportionally reduces the bandwidth the stream uses. However, in sessions that have the media mode set to relayed, lowering the frame rate does not reduce the stream's bandwidth. (See The OpenTok Media Router and media modes.)

Publisher

@Deprecated
protected Publisher(android.content.Context context,
                    java.lang.String name,
                    boolean audioTrack,
                    boolean videoTrack,
                    BaseVideoCapturer capturer,
                    Publisher.CameraCaptureResolution resolution,
                    Publisher.CameraCaptureFrameRate frameRate,
                    BaseVideoRenderer renderer)

Deprecated.

Returns a new Publisher instance based on the Publisher.Builder settings.

Publisher

protected Publisher(android.content.Context context,
                    java.lang.String name,
                    boolean audioTrack,
                    int maxAudioBitrate,
                    boolean videoTrack,
                    BaseVideoCapturer capturer,
                    Publisher.CameraCaptureResolution resolution,
                    Publisher.CameraCaptureFrameRate frameRate,
                    BaseVideoRenderer renderer,
                    boolean enableOpusDtx,
                    boolean scalableScreenshare,
                    boolean subscriberAudioFallback,
                    boolean publisherAudioFallback)

Creates a new Publisher object. If you extend the Publisher class, you can call this constructor from the child class.

Parameters:

context - The android.content.Context for the Publisher.

name - The name of the publisher video. The Stream.getName() method for a published by this publisher will return this value (on all clients).

audioTrack - Whether to include an audio track in the published stream.

maxAudioBitrate - The desired bitrate of the audio, in bits per second.

videoTrack - Whether to include a video track in the published stream.

capturer - The video capturer for the publisher.

renderer - The video renderer for the publisher.

enableOpusDtx - Whether to enable Opus DTX.

scalableScreenshare - Whether to allow use of scalable video for a publisher that has the videoType set to PublisherKitVideoTypeScreen (true) or not (false, the default).

subscriberAudioFallback - Whether the stream will use the subscriber audio-fallback feature (true) or not

publisherAudioFallback - Whether the stream will use the publisher audio-fallback feature (true) or not

Publisher

@Deprecated
protected Publisher(android.content.Context context,
                    java.lang.String name,
                    boolean audioTrack,
                    int maxAudioBitrate,
                    boolean videoTrack,
                    BaseVideoCapturer capturer,
                    Publisher.CameraCaptureResolution resolution,
                    Publisher.CameraCaptureFrameRate frameRate,
                    BaseVideoRenderer renderer,
                    boolean enableOpusDtx,
                    boolean scalableScreenshare)

Deprecated.

Creates a new Publisher object. If you extend the Publisher class, you can call this constructor from the child class.

Parameters:

context - The android.content.Context for the Publisher.

name - The name of the publisher video. The Stream.getName() method for a published by this publisher will return this value (on all clients).

audioTrack - Whether to include an audio track in the published stream.

maxAudioBitrate - The desired bitrate of the audio, in bits per second.

videoTrack - Whether to include a video track in the published stream.

capturer - The video capturer for the publisher.

renderer - The video renderer for the publisher.

enableOpusDtx - Whether to enable Opus DTX.

scalableScreenshare - Whether to allow use of scalable video for a publisher that has the videoType set to PublisherKitVideoTypeScreen (true) or not (false, the default).

Method Detail

setCameraListener

public void setCameraListener(Publisher.CameraListener listener)

Sets a Publisher.CameraListener object to monitor when the camera used by the publisher changes.

Parameters:

listener - The Publisher.CameraListener instance.

setCameraId

@Deprecated
public void setCameraId(int cameraId)

Deprecated.

Sets the desired camera. cameraId can be a value between 0 and android.hardware.Camera#getNumberOfCameras() - 1.

When the camera used by the Publisher changes, the Publisher.CameraListener.onCameraChanged(Publisher publisher, int newCameraId) method is called.

This method is deprecated. You should use the new cycleCamera() method to cycle between cameras, if there are multiple cameras on the device.

Parameters:

cameraId - the id of the camera you want to use on this publisher

cycleCamera

public void cycleCamera()

Cycles between cameras, if there are multiple cameras on the device. When the camera used by the Publisher changes, the Publisher.CameraListener.onCameraChanged(Publisher publisher, int newCameraId) method is called.

swapCamera

@Deprecated
public void swapCamera()

Deprecated.

This method is deprecated. You should use the new cycleCamera() method to cycle between cameras, if there are multiple cameras on the device.

If you are using a custom video capturer, implement the BaseVideoCapturer.CaptureSwitch interface in the object that extends BaseVideoCapturer, and implement the BaseVideoCapturer.CaptureSwitch.swapCamera(int cameraId) method to define the behavior of the Publisher.swapCamera() method.

getCameraId

@Deprecated
public int getCameraId()

Deprecated.

Returns the currently active camera ID. This value is either 0 (for the back-facing camera) or 1 (for the front-facing camera). If setCameraId(int) is never called, the return value is 1 (for the front-facing camera).

This method is deprecated. You should use the new cycleCamera() method to cycle between cameras, if there are multiple cameras on the device.

onCameraChanged

protected void onCameraChanged(int newCameraId)

Invoked when the publisher changes the active camera.

If you extend the Publisher class, you can override this method instead of the onCameraChanged() method of the Publisher.CameraListener interface.

Parameters:

newCameraId - The ID of the new active camera.

onCameraError

protected void onCameraError(OpentokError error)

Invoked when there is an error accessing the camera.

Parameters:

error - The error.

startPreview

@Deprecated
public void startPreview()

Deprecated.

From version 2.17.0 on, this method doesn't do anything. As soon as the Publisher object is created the camera's video is displayed in the Publisher's view. This change makes the behaviour consistent across OpenTok client SDKs.