PublisherKit.Builder (OpenTok Android SDK)

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

Direct Known Subclasses:

Publisher.Builder

Enclosing class:

PublisherKit
```
public static class PublisherKit.Builder
extends java.lang.Object
```
Used to build a PublisherKit object. Instantiate a Builder object using the PublisherKit.Builder(Context context) constructor. Then call methods of the Builder instance to add settings for the publisher. Then call the build() method, which returns a PublisherKit object.
Use the Session.publish(PublisherKit publisher) method to start streaming from the publisher into a session.
Publishers cannot be reused. Instantiate a new PublisherKit object each time you want to publish a new stream.

See Also:

PublisherKit.setPublisherListener(PublisherKit.PublisherListener listener)

Constructor Summary

Constructors
Constructor and Description

Builder(Context context)
Instantiates a PublisherKit.Builder object.

Constructors
Constructor and Description
`Builder(Context context)` Instantiates a `PublisherKit.Builder` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PublisherKit.Builder`	`audioBitrate(int bitsPerSecond)` Sets the desired bitrate for the published audio, in bits per second.
`PublisherKit.Builder`	`audioTrack(boolean enabled)` Sets whether to include an audio track in the published stream (`true`, the default) or not (`false`).
`PublisherKit`	`build()` Returns a new `PublisherKit` instance based on the `PublisherKit.Builder` settings.
`PublisherKit.Builder`	`capturer(BaseVideoCapturer capturer)` Sets the video capturer to use for the publisher.
`PublisherKit.Builder`	`name(java.lang.String name)` Sets the name of the published video.
`PublisherKit.Builder`	`renderer(BaseVideoRenderer renderer)` Sets the video renderer to use for the publisher.
`PublisherKit.Builder`	`videoTrack(boolean enabled)` Sets whether to include an video track in the published stream (`true`, the default) or not (`false`).

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

- Constructor Detail
  - Builder
```
public Builder(Context context)
```
    Instantiates a PublisherKit.Builder object.
    
    Parameters:
    
    context - The android.content.Context for the publisher.
- Method Detail
  - name
```
public PublisherKit.Builder name(java.lang.String name)
```
    Sets the name of the published video. The Stream.name property for a stream published by this publisher will be set to this value (on all clients).
  - audioTrack
```
public PublisherKit.Builder audioTrack(boolean enabled)
```
    Sets whether to include an audio track in the published stream (true, the default) or not (false). Creating a publisher without an audio track can save CPU resources and reduce the bandwidth used by the stream.
    If you call this and pass in false, the audio subsystem will not be initialized for the publisher, and calling the PublisherKit.setPublishAudio(boolean publishAudio) method will have no effect. If your application does not require the use of audio, it is recommended to use this Builder setting rather than use the PublisherKit.setPublishAudio(boolean publishAudio) method, which only temporarily disables the audio track.
  - videoTrack
```
public PublisherKit.Builder videoTrack(boolean enabled)
```
    Sets whether to include an video track in the published stream (true, the default) or not (false). Creating a publisher without a video track can save CPU resources and reduce the bandwidth used by the stream.
    If you call this and pass in false, the video subsystem will not be initialized for the publisher, and calling the PublisherKit.setPublishVideo(boolean publishVideo) method will have no effect. If your application does not require the use of audio, it is recommended to use this Builder setting rather than use the PublisherKit.setPublishVideo(boolean publishVideo) method, which only temporarily disables the video track.
  - capturer
```
public PublisherKit.Builder capturer(BaseVideoCapturer capturer)
```
    Sets the video capturer to use for the publisher.
  - renderer
```
public PublisherKit.Builder renderer(BaseVideoRenderer renderer)
```
    Sets the video renderer to use for the publisher.
  - audioBitrate
```
public PublisherKit.Builder audioBitrate(int bitsPerSecond)
```
    Sets the desired bitrate for the published audio, in bits per second. The supported range of values is 6,000 - 510,000. (Invalid values are ignored.) Set this value to enable high-quality audio (or to reduce bandwidth usage with lower-quality audio).
    The following are recommended settings:
    - 8,000 - 12,000 for narrowband (NB) speech
    - 16,000 - 20,000 for wideband (WB) speech
    - 28,000 - 40,000 for full-band (FB) speech
    - 48,000 - 64,000 for full-band (FB) mono music
    - 64,000 - 128,000 for full-band (FB) stereo music
    The default value is 40,000.
    To set other audio settings, see the AudioDeviceManager class.
    Parameters:
    
    bitsPerSecond - The desired bitrate of the audio, in bits per second.
    
    Returns:
    
    This Builder object.
  - build
```
public PublisherKit build()
```
    Returns a new PublisherKit instance based on the PublisherKit.Builder settings.

Class PublisherKit.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

name

audioTrack

videoTrack

capturer

renderer

audioBitrate

build