PublisherKit (OpenTok Android SDK)

java.lang.Object
- com.opentok.android.PublisherKit

Direct Known Subclasses:

Publisher
```
public class PublisherKit
extends java.lang.Object
```
A publisher captures an audio-video stream from the sources you specify. You can then publish the audio-video stream to an OpenTok session by calling the Session.publish(PublisherKit publisher) method.
Create a subclass of PublisherKit if you are interested in providing your own video capturing and rendering implementation. Otherwise, use the Publisher class, which includes a pre-built video capturer and renderer.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PublisherKit.AudioLevelListener` Monitors changes in the audio level of the publisher.
`static interface`	`PublisherKit.AudioStatsListener` Defines the listener object for getting publisher audio statistcs.
`static class`	`PublisherKit.Builder` Used to build a `PublisherKit` object.
`static class`	`PublisherKit.PublisherAudioStats` Defines audio statistics for a publisher.
`static class`	`PublisherKit.PublisherKitVideoType` Defines values for the `setPublisherVideoType(PublisherKitVideoType type)` method.
`static interface`	`PublisherKit.PublisherListener` Monitors when a publisher starts and stops streaming to the session.
`static class`	`PublisherKit.PublisherVideoStats` Defines video statistics for a publisher.
`static interface`	`PublisherKit.VideoStatsListener` Defines the listener object for getting publisher video statistcs.

Field Summary

Fields
Modifier and Type	Field and Description
`protected PublisherKit.AudioLevelListener`	`audioLevelListener`
`protected PublisherKit.AudioStatsListener`	`audioStatsListener`
`protected BaseVideoCapturer`	`capturer`
`protected android.content.Context`	`context`
`protected android.os.Handler`	`handler`
`protected PublisherKit.PublisherListener`	`publisherListener`
`protected BaseVideoRenderer`	`renderer`
`protected Session`	`session`
`protected PublisherKit.VideoStatsListener`	`videoStatsListener`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`PublisherKit(android.content.Context context)` Deprecated.
	`PublisherKit(android.content.Context context, java.lang.String name)` Deprecated.
	`PublisherKit(android.content.Context context, java.lang.String name, boolean audioTrack, boolean videoTrack)` Deprecated.
`protected`	`PublisherKit(android.content.Context context, java.lang.String name, boolean audioTrack, boolean videoTrack, BaseVideoCapturer capturer, BaseVideoRenderer renderer)` Deprecated.
`protected`	`PublisherKit(android.content.Context context, java.lang.String name, boolean audioTrack, int maxAudioBitRate, boolean videoTrack, BaseVideoCapturer capturer, BaseVideoRenderer renderer)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`attachToSession(Session session)`
`void`	`destroy()` Releases this object, including all hardware and UI resources bound to it.
`protected void`	`detachFromSession(Session session)`
`boolean`	`getAudioFallbackEnabled()` Whether the stream uses the audio-fallback feature (`true`) or not (`false`).
`BaseVideoCapturer`	`getCapturer()` Returns the video capturer used by this publisher.
`java.lang.String`	`getName()` The stream name.
`boolean`	`getPublishAudio()` Whether the Publisher is publishing audio (`true`) or not ( `false`).
`PublisherKit.PublisherKitVideoType`	`getPublisherVideoType()` Returns the type of video for this publisher.
`boolean`	`getPublishVideo()` Whether the Publisher is publishing video (`true`) or not ( `false`).
`BaseVideoRenderer`	`getRenderer()` Returns the video renderer for this publisher.
`Session`	`getSession()` Returns the `Session` bound to this Publisher instance.
`Stream`	`getStream()` Returns the stream object corresponding the the Publisher's stream.
`android.view.View`	`getView()` Returns the android.view.View object that contains the Publisher video.
`protected void`	`onAudioLevelUpdated(float audioLevel)`
`protected void`	`onError(OpentokError error)` Invoked when the publisher fails.
`void`	`onPause()` Do not call directly; call `Session.onPause()` instead.
`void`	`onResume()` Do not call directly; call `Session.onResume()` instead.
`protected void`	`onStreamCreated(Stream stream)` Invoked when the publisher's stream is created.
`protected void`	`onStreamDestroyed(Stream stream)` Invoked when the publisher's stream is destroyed.
`void`	`setAudioFallbackEnabled(boolean enabled)` Whether the stream will use the audio-fallback feature (`true`) or not (`false`).
`void`	`setAudioLevelListener(PublisherKit.AudioLevelListener listener)` Binds an `PublisherKit.AudioLevelListener` to this PublisherKit instance to monitor audio level updates.
`void`	`setAudioStatsListener(PublisherKit.AudioStatsListener listener)` Sets up a listener for publisher audio statistics.
`void`	`setCapturer(BaseVideoCapturer newCapturer)` Deprecated.
`void`	`setName(java.lang.String name)` Deprecated.
`void`	`setPublishAudio(boolean publishAudio)` Toggles publishing of audio on or off, based on the value passed in.
`void`	`setPublisherListener(PublisherKit.PublisherListener listener)` Binds a `PublisherKit.PublisherListener` to this Publisher instance to monitor state changes.
`void`	`setPublisherVideoType(PublisherKit.PublisherKitVideoType type)` Specifies the type of video for this stream.
`void`	`setPublishVideo(boolean publishVideo)` Toggles publishing of video on or off, based on the value passed in.
`void`	`setRenderer(BaseVideoRenderer renderer)` Deprecated.
`void`	`setStyle(java.lang.String key, java.lang.String value)` Sets a style for the video renderer used by this publisher.
`void`	`setVideoStatsListener(PublisherKit.VideoStatsListener listener)` Sets up a listener for publisher video statistics.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - handler
```
protected android.os.Handler handler
```
  - publisherListener
```
protected PublisherKit.PublisherListener publisherListener
```
  - audioLevelListener
```
protected PublisherKit.AudioLevelListener audioLevelListener
```
  - videoStatsListener
```
protected PublisherKit.VideoStatsListener videoStatsListener
```
  - audioStatsListener
```
protected PublisherKit.AudioStatsListener audioStatsListener
```
  - session
```
protected Session session
```
  - context
```
protected android.content.Context context
```
  - renderer
```
protected BaseVideoRenderer renderer
```
  - capturer
```
protected BaseVideoCapturer capturer
```
- Constructor Detail
  - PublisherKit
```
@Deprecated
protected PublisherKit(android.content.Context context,
                                   java.lang.String name,
                                   boolean audioTrack,
                                   boolean videoTrack,
                                   BaseVideoCapturer capturer,
                                   BaseVideoRenderer renderer)
```
    Deprecated.
    
    Creates a new PublisherKit instance. If you extend the PublisherKit class, you can call this constructor to instantiate a publisher object.
    Use the Session.publish(PublisherKit publisher) method to start streaming from this publisher into a session.
    The getView() method returns the android.view.View object containing the published video.
    Publishers cannot be reused. Instantiate a new PublisherKit object each time you want to publish a new stream.
    
    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.
    
    videoTrack - Whether to include a video track in the published stream.
    
    renderer - The video capturer for the publisher.
    
    renderer - The video renderer for the publisher.
    
    See Also:
    
    setPublisherListener(PublisherKit.PublisherListener listener)
  - PublisherKit
```
protected PublisherKit(android.content.Context context,
                       java.lang.String name,
                       boolean audioTrack,
                       int maxAudioBitRate,
                       boolean videoTrack,
                       BaseVideoCapturer capturer,
                       BaseVideoRenderer renderer)
```
  - PublisherKit
```
@Deprecated
public PublisherKit(android.content.Context context,
                                java.lang.String name,
                                boolean audioTrack,
                                boolean videoTrack)
```
    Deprecated.
    
    Creates a new PublisherKit instance. This method is deprecated. Use the PublisherKit.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 getView() method returns the android.view.View object containing the published video.
    Publishers cannot be reused.
    
    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.
  - PublisherKit
```
@Deprecated
public PublisherKit(android.content.Context context)
```
    Deprecated.
    
    Creates a new PublisherKit instance. This method is deprecated. Use the PublisherKit.Builder class to instantiate a PublisherKit object.
    Use the Session.publish(PublisherKit publisher) method to start streaming from this publisher into a session.
    The getView() method returns the android.view.View object containing the published video.
    You cannot reuse a publisher after you have called the destroy() method.
    
    Parameters:
    
    context - The android.content.Context for the Publisher.
    
    See Also:
    
    setPublisherListener(PublisherKit.PublisherListener listener)
  - PublisherKit
```
@Deprecated
public PublisherKit(android.content.Context context,
                                java.lang.String name)
```
    Deprecated.
    
    Creates a new PublisherKit instance. This method is deprecated. Use the PublisherKit.Builder class to instantiate a PublisherKit object.
    Use the Session.publish(PublisherKit publisher) method to start streaming from this publisher into a session.
    The getView() method returns the android.view.View object containing the published video.
    You cannot reuse a publisher after you have called the destroy() method.
    
    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).
    
    See Also:
    
    setPublisherListener(PublisherKit.PublisherListener listener)
- Method Detail
  - onPause
```
public void onPause()
```
    Do not call directly; call Session.onPause() instead.
  - onResume
```
public void onResume()
```
    Do not call directly; call Session.onResume() instead.
  - destroy
```
public void destroy()
```
    Releases this object, including all hardware and UI resources bound to it. After you have called this method, you cannot reuse the publisher.
  - setPublishVideo
```
public void setPublishVideo(boolean publishVideo)
```
    Toggles publishing of video on or off, based on the value passed in.
    
    Parameters:
    
    publishVideo - Whether to publish video (true) or not ( false).
  - setPublishAudio
```
public void setPublishAudio(boolean publishAudio)
```
    Toggles publishing of audio on or off, based on the value passed in.
    
    Parameters:
    
    publishAudio - Whether to publish audio (true) or not ( false).
  - setName
```
@Deprecated
public void setName(java.lang.String name)
```
    Deprecated.
    
    Set the name for this stream. The name appears at the bottom of the publisher video and at the bottom of subscriber videos associated with the published stream. You can set this name after initializing the publisher and before the PublisherKit.PublisherListener.onStreamCreated(PublisherKit publisher, Stream stream) method is called. Setting the property after the PublisherKit.PublisherListener.onStreamCreated(PublisherKit publisher, Stream stream) method is called has no effect on the name displayed for the stream.
    The default name is "" (an empty string).
  - setPublisherVideoType
```
public void setPublisherVideoType(PublisherKit.PublisherKitVideoType type)
```
    Specifies the type of video for this stream. Set this to one of the following values:
    - PublisherKitVideoType.PublisherKitVideoTypeScreen — Optimizes the video encoding for screen sharing. It is recommended to use a low frame rate (5 frames per second or lower) with this video type. When using the screen video type in a session that uses the OpenTok Media Server, you should call the setAudioFallbackEnabled(boolean enabled) method and pass in false before calling the Session.publish(com.opentok.android.PublisherKit) method; this disables the audio-only fallback feature, so that the video does not drop out in subscribers. See The OpenTok Media Router and media modes.
    - PublisherKitVideoType.PublisherKitVideoTypeCamera — This is the default setting, which you should use when using a camera as the video source.
  - getName
```
public java.lang.String getName()
```
    The stream name. The name appears at the bottom of Subscriber videos.
    
    Returns:
    
    publisher name
  - getPublishVideo
```
public boolean getPublishVideo()
```
    Whether the Publisher is publishing video (true) or not ( false).
  - getPublishAudio
```
public boolean getPublishAudio()
```
    Whether the Publisher is publishing audio (true) or not ( false).
  - getSession
```
public Session getSession()
```
    Returns the Session bound to this Publisher instance.
    
    Returns:
    
    The Session bound to this Publisher instance.
    
    See Also:
    
    Session.publish(com.opentok.android.PublisherKit)
  - getStream
```
public Stream getStream()
```
    Returns the stream object corresponding the the Publisher's stream.
    
    Returns:
    
    The stream object.
  - getPublisherVideoType
```
public PublisherKit.PublisherKitVideoType getPublisherVideoType()
```
    Returns the type of video for this publisher.
    
    See Also:
    
    setPublisherVideoType(PublisherKitVideoType type)
  - setPublisherListener
```
public void setPublisherListener(PublisherKit.PublisherListener listener)
```
    Binds a PublisherKit.PublisherListener to this Publisher instance to monitor state changes.
    
    Parameters:
    
    listener - The PublisherKit.PublisherListener that will monitor this instance, or null to disconnect a listener.
  - setAudioLevelListener
```
public void setAudioLevelListener(PublisherKit.AudioLevelListener listener)
```
    Binds an PublisherKit.AudioLevelListener to this PublisherKit instance to monitor audio level updates.
    
    Parameters:
    
    listener - The PublisherKit.AudioLevelListener that will monitor this instance. Set this to null to disconnect a listener and stop monitoring audio levels.
  - setStyle
```
public void setStyle(java.lang.String key,
                     java.lang.String value)
```
    Sets a style for the video renderer used by this publisher.
    By default, there is only one pre-defined style key: BaseVideoRenderer.STYLE_VIDEO_SCALE. You can set a value for this key to determine the scaling of the video. The following values are supported:
    - BaseVideoRenderer.STYLE_VIDEO_FILL — The video scales to fill the entire area of the renderer, with cropping as needed.
    - BaseVideoRenderer.STYLE_VIDEO_FIT — The video shrinks, as needed, so that the entire video is visible, with pillarboxing. If you do not set this style the default setting is BaseVideoRenderer.STYLE_VIDEO_FIT.
    Calling this method is equivalent to calling getRenderer().setStyle(). However, if you extend this class, you can override this method to support other styles and behaviors.
    Parameters:
    
    key - The style to set.
    
    value - The value you are setting the style to.
  - setRenderer
```
@Deprecated
public void setRenderer(BaseVideoRenderer renderer)
```
    Deprecated.
    
    Sets the video renderer for this publisher. This method is deprecated. Instead, call the setRenderer(BaseVideoRenderer renderer) method when using the Builder to create the PublisherKit instance.
    
    Parameters:
    
    renderer - The video renderer for this publisher to use.
  - getRenderer
```
public BaseVideoRenderer getRenderer()
```
    Returns the video renderer for this publisher.
  - getCapturer
```
public BaseVideoCapturer getCapturer()
```
    Returns the video capturer used by this publisher.
  - setCapturer
```
@Deprecated
public void setCapturer(BaseVideoCapturer newCapturer)
```
    Deprecated.
    
    Sets the video capturer for this publisher.
    This method is deprecated. Instead, call the setCapturer(BaseVideoCapturer capturer) method when using the builder to create the PublisherKit instance.
    
    Parameters:
    
    newCapturer - The video capturer for this publisher to use. This call should be called before publishing or starting a preview
  - getView
```
public android.view.View getView()
```
    Returns the android.view.View object that contains the Publisher video.
  - setVideoStatsListener
```
public void setVideoStatsListener(PublisherKit.VideoStatsListener listener)
```
    Sets up a listener for publisher video statistics. The listener object implements the PublisherKit.VideoStatsListener.onVideoStats(PublisherKit publisher, PublisherKit.PublisherVideoStats[] stats) method. This method is called periodically to report the following:
    - Total video packets lost
    - Total video packets sent
    - Total video bytes sent
    This is a beta feature.
    See Also:
    
    setAudioStatsListener(AudioStatsListener listener)
  - setAudioStatsListener
```
public void setAudioStatsListener(PublisherKit.AudioStatsListener listener)
```
    Sets up a listener for publisher audio statistics. The listener object implements the PublisherKit.AudioStatsListener.onAudioStats(PublisherKit publisher, PublisherKit.PublisherAudioStats[] stats) method. This method is called periodically to report the following:
    - Total audio packets lost
    - Total audio packets sent
    - Total audio bytes sent
    This is a beta feature.
    See Also:
    
    setVideoStatsListener(VideoStatsListener listener)
  - setAudioFallbackEnabled
```
public void setAudioFallbackEnabled(boolean enabled)
```
    Whether the stream will use the audio-fallback feature (true) or not (false). The audio-fallback feature is available in sessions that use the the OpenTok Media Router. With the audio-fallback feature enabled (the default), when the OpenTok Media Router determines that a stream's quality has degraded significantly for a specific subscriber, it disables the video in that subscriber in order to preserve audio quality.
    The default setting is true (the audio-fallback feature is enabled). To turn off the audio-fallback feature, call this method (and pass in false) before calling the Session.publish(com.opentok.android.PublisherKit) method.
    
    See Also:
    
    SubscriberKit.VideoListener.onVideoDisabled(SubscriberKit subscriber, String reason), the OpenTok Media Router and media modes
  - getAudioFallbackEnabled
```
public boolean getAudioFallbackEnabled()
```
    Whether the stream uses the audio-fallback feature (true) or not (false).
    
    See Also:
    
    setAudioFallbackEnabled(boolean enabled)
  - onStreamCreated
```
protected void onStreamCreated(Stream stream)
```
    Invoked when the publisher's stream is created.
    If you extend the PublisherKit class, you can override this method instead of the onStreamCreated() method of the PublisherKit.PublisherListener interface.
    
    Parameters:
    
    stream - The stream that that is created.
  - onStreamDestroyed
```
protected void onStreamDestroyed(Stream stream)
```
    Invoked when the publisher's stream is destroyed.
    If you extend the PublisherKit class, you can override this method instead of the onStreamDestroyed() method of the PublisherKit.PublisherListener interface.
    
    Parameters:
    
    stream - The stream that that is destroyed.
  - onError
```
protected void onError(OpentokError error)
```
    Invoked when the publisher fails.
    If you extend the PublisherKit class, you can override this method instead of the onError() method of the PublisherKit.PublisherListener interface.
    
    Parameters:
    
    error - The error that invoked this callback.
  - onAudioLevelUpdated
```
protected void onAudioLevelUpdated(float audioLevel)
```
  - attachToSession
```
protected void attachToSession(Session session)
```
  - detachFromSession
```
protected void detachFromSession(Session session)
```

Class PublisherKit

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

handler

publisherListener

audioLevelListener

videoStatsListener

audioStatsListener

session

context

renderer

capturer

Constructor Detail

PublisherKit

PublisherKit

PublisherKit

PublisherKit

PublisherKit

Method Detail

onPause

onResume

destroy

setPublishVideo

setPublishAudio

setName

setPublisherVideoType

getName

getPublishVideo

getPublishAudio

getSession

getStream

getPublisherVideoType

setPublisherListener

setAudioLevelListener

setStyle

setRenderer

getRenderer

getCapturer

setCapturer

getView

setVideoStatsListener

setAudioStatsListener

setAudioFallbackEnabled

getAudioFallbackEnabled

onStreamCreated

onStreamDestroyed

onError

onAudioLevelUpdated

attachToSession

detachFromSession