Session

java.lang.Object
- net.majorkernelpanic.streaming.Session

```
public class Session
extends java.lang.Object
```
You should instantiate this class with the SessionBuilder.
This is the class you will want to use to stream audio and or video to some peer using RTP.
It holds a VideoStream and a AudioStream together and provides synchronous and asynchronous functions to start and stop those steams. You should implement a callback interface Session.Callback to receive notifications and error reports.
If you want to stream to a RTSP server, you will need an instance of this class and hand it to a RtspClient. If you don't use the RTSP protocol, you will still need to send a session description to the receiver for him to be able to decode your audio/video streams. You can obtain this session description by calling configure() or syncConfigure() to configure the session with its parameters (audio samplingrate, video resolution) and then getSessionDescription().
See the example 2 here: https://github.com/fyhertz/libstreaming-examples to see an example of how to get a SDP.
See the example 3 here: https://github.com/fyhertz/libstreaming-examples to see an example of how to stream to a RTSP server.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Session.Callback` The callback interface you need to implement to get some feedback Those will be called from the UI thread.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ERROR_CAMERA_ALREADY_IN_USE` Some app is already using a camera (Camera.open() has failed).
`static int`	`ERROR_CAMERA_HAS_NO_FLASH` The phone has no flash.
`static int`	`ERROR_CONFIGURATION_NOT_SUPPORTED` The phone may not support some streaming parameters that you are trying to use (bit rate, frame rate, resolution...).
`static int`	`ERROR_INVALID_SURFACE` The supplied SurfaceView is not a valid surface, or has not been created yet.
`static int`	`ERROR_OTHER` Some other error occurred !
`static int`	`ERROR_STORAGE_NOT_READY` The internal storage of the phone is not ready.
`static int`	`ERROR_UNKNOWN_HOST` The destination set with `setDestination(String)` could not be resolved.
`static int`	`STREAM_AUDIO`
`static int`	`STREAM_VIDEO`
`static java.lang.String`	`TAG`

Constructor Summary

Constructors
Constructor and Description

Session()
Creates a streaming session that can be customized by adding tracks.

Constructors
Constructor and Description
`Session()` Creates a streaming session that can be customized by adding tracks.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`configure()` Configures all streams of the session.
`AudioStream`	`getAudioTrack()` Returns the underlying `AudioStream` used by the `Session`.
`long`	`getBitrate()` Returns an approximation of the bandwidth consumed by the session in bit per second.
`Session.Callback`	`getCallback()` Returns the `Session.Callback` interface that was set with `setCallback(Callback)` or null if none was set.
`int`	`getCamera()` Returns the id of the camera currently selected.
`java.lang.String`	`getDestination()` Returns the destination set with `setDestination(String)`.
`java.lang.String`	`getSessionDescription()` Returns a Session Description that can be stored in a file or sent to a client with RTSP.
`Stream`	`getTrack(int id)`
`VideoStream`	`getVideoTrack()` Returns the underlying `VideoStream` used by the `Session`.
`boolean`	`isStreaming()` Indicates if a track is currently running.
`void`	`release()` Deletes all existing tracks & release associated resources.
`void`	`setAudioQuality(AudioQuality quality)` Sets the configuration of the stream.
`void`	`setCallback(Session.Callback callback)` Sets the callback interface that will be called by the `Session`.
`void`	`setDestination(java.lang.String destination)` The destination address for all the streams of the session.
`void`	`setOrigin(java.lang.String origin)` The origin address of the session.
`void`	`setPreviewOrientation(int orientation)` Sets the orientation of the preview.
`void`	`setSurfaceView(SurfaceView view)` Sets a Surface to show a preview of recorded media (video).
`void`	`setTimeToLive(int ttl)` Set the TTL of all packets sent during the session.
`void`	`setVideoQuality(VideoQuality quality)` Sets the configuration of the stream.
`void`	`start()` Asynchronously starts all streams of the session.
`void`	`startPreview()` Asynchronously starts the camera preview.
`void`	`stop()` Stops all existing streams.
`void`	`stopPreview()` Asynchronously stops the camera preview.
`void`	`switchCamera()` Switch between the front facing and the back facing camera of the phone.
`void`	`syncConfigure()` Does the same thing as `configure()`, but in a synchronous manner.
`void`	`syncStart()` Does the same thing as `start()`, but in a synchronous manner.
`void`	`syncStart(int id)` Starts a stream in a synchronous manner.
`void`	`syncStop()` Stops all existing streams in a synchronous manner.
`void`	`toggleFlash()` Toggles the LED of the phone if it has one.
`boolean`	`trackExists(int id)`

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

- Field Detail
  - TAG
```
public static final java.lang.String TAG
```
    See Also:
    
    Constant Field Values
  - STREAM_VIDEO
```
public static final int STREAM_VIDEO
```
    See Also:
    
    Constant Field Values
  - STREAM_AUDIO
```
public static final int STREAM_AUDIO
```
    See Also:
    
    Constant Field Values
  - ERROR_CAMERA_ALREADY_IN_USE
```
public static final int ERROR_CAMERA_ALREADY_IN_USE
```
    Some app is already using a camera (Camera.open() has failed).
    
    See Also:
    
    Constant Field Values
  - ERROR_CONFIGURATION_NOT_SUPPORTED
```
public static final int ERROR_CONFIGURATION_NOT_SUPPORTED
```
    The phone may not support some streaming parameters that you are trying to use (bit rate, frame rate, resolution...).
    
    See Also:
    
    Constant Field Values
  - ERROR_STORAGE_NOT_READY
```
public static final int ERROR_STORAGE_NOT_READY
```
    The internal storage of the phone is not ready. libstreaming tried to store a test file on the sdcard but couldn't. See H264Stream and AACStream to find out why libstreaming would want to something like that.
    
    See Also:
    
    Constant Field Values
  - ERROR_CAMERA_HAS_NO_FLASH
```
public static final int ERROR_CAMERA_HAS_NO_FLASH
```
    The phone has no flash.
    
    See Also:
    
    Constant Field Values
  - ERROR_INVALID_SURFACE
```
public static final int ERROR_INVALID_SURFACE
```
    The supplied SurfaceView is not a valid surface, or has not been created yet.
    
    See Also:
    
    Constant Field Values
  - ERROR_UNKNOWN_HOST
```
public static final int ERROR_UNKNOWN_HOST
```
    The destination set with setDestination(String) could not be resolved. May mean that the phone has no access to the internet, or that the DNS server could not resolved the host name.
    
    See Also:
    
    Constant Field Values
  - ERROR_OTHER
```
public static final int ERROR_OTHER
```
    Some other error occurred !
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Session
```
public Session()
```
    Creates a streaming session that can be customized by adding tracks.
- Method Detail
  - getAudioTrack
```
public AudioStream getAudioTrack()
```
    Returns the underlying AudioStream used by the Session.
  - getVideoTrack
```
public VideoStream getVideoTrack()
```
    Returns the underlying VideoStream used by the Session.
  - setCallback
```
public void setCallback(Session.Callback callback)
```
    Sets the callback interface that will be called by the Session.
    
    Parameters:
    
    callback - The implementation of the Session.Callback interface
  - setOrigin
```
public void setOrigin(java.lang.String origin)
```
    The origin address of the session. It appears in the session description.
    
    Parameters:
    
    origin - The origin address
  - setDestination
```
public void setDestination(java.lang.String destination)
```
    The destination address for all the streams of the session.
    Changes will be taken into account the next time you start the session.
    
    Parameters:
    
    destination - The destination address
  - setTimeToLive
```
public void setTimeToLive(int ttl)
```
    Set the TTL of all packets sent during the session.
    Changes will be taken into account the next time you start the session.
    
    Parameters:
    
    ttl - The Time To Live
  - setVideoQuality
```
public void setVideoQuality(VideoQuality quality)
```
    Sets the configuration of the stream.
    You can call this method at any time and changes will take effect next time you call configure().
    
    Parameters:
    
    quality - Quality of the stream
  - setSurfaceView
```
public void setSurfaceView(SurfaceView view)
```
    Sets a Surface to show a preview of recorded media (video).
    You can call this method at any time and changes will take effect next time you call start() or startPreview().
  - setPreviewOrientation
```
public void setPreviewOrientation(int orientation)
```
    Sets the orientation of the preview.
    You can call this method at any time and changes will take effect next time you call configure().
    
    Parameters:
    
    orientation - The orientation of the preview
  - setAudioQuality
```
public void setAudioQuality(AudioQuality quality)
```
    Sets the configuration of the stream.
    You can call this method at any time and changes will take effect next time you call configure().
    
    Parameters:
    
    quality - Quality of the stream
  - getCallback
```
public Session.Callback getCallback()
```
    Returns the Session.Callback interface that was set with setCallback(Callback) or null if none was set.
  - getSessionDescription
```
public java.lang.String getSessionDescription()
```
    Returns a Session Description that can be stored in a file or sent to a client with RTSP.
    
    Returns:
    
    The Session Description.
    
    Throws:
    
    java.lang.IllegalStateException - Thrown when setDestination(String) has never been called.
  - getDestination
```
public java.lang.String getDestination()
```
    Returns the destination set with setDestination(String).
  - getBitrate
```
public long getBitrate()
```
    Returns an approximation of the bandwidth consumed by the session in bit per second.
  - isStreaming
```
public boolean isStreaming()
```
    Indicates if a track is currently running.
  - configure
```
public void configure()
```
    Configures all streams of the session.
  - syncConfigure
```
public void syncConfigure()
                   throws CameraInUseException,
                          StorageUnavailableException,
                          ConfNotSupportedException,
                          InvalidSurfaceException,
                          java.lang.RuntimeException,
                          java.io.IOException
```
    Does the same thing as configure(), but in a synchronous manner.
    Throws exceptions in addition to calling a callback Session.Callback.onSessionError(int, int, Exception) when an error occurs.
    
    Throws:
    
    CameraInUseException
    
    StorageUnavailableException
    
    ConfNotSupportedException
    
    InvalidSurfaceException
    
    java.lang.RuntimeException
    
    java.io.IOException
  - start
```
public void start()
```
    Asynchronously starts all streams of the session.
  - syncStart
```
public void syncStart(int id)
               throws CameraInUseException,
                      StorageUnavailableException,
                      ConfNotSupportedException,
                      InvalidSurfaceException,
                      java.net.UnknownHostException,
                      java.io.IOException
```
    Starts a stream in a synchronous manner.
    Throws exceptions in addition to calling a callback.
    
    Parameters:
    
    id - The id of the stream to start
    
    Throws:
    
    CameraInUseException
    
    StorageUnavailableException
    
    ConfNotSupportedException
    
    InvalidSurfaceException
    
    java.net.UnknownHostException
    
    java.io.IOException
  - syncStart
```
public void syncStart()
               throws CameraInUseException,
                      StorageUnavailableException,
                      ConfNotSupportedException,
                      InvalidSurfaceException,
                      java.net.UnknownHostException,
                      java.io.IOException
```
    Does the same thing as start(), but in a synchronous manner.
    Throws exceptions in addition to calling a callback.
    
    Throws:
    
    CameraInUseException
    
    StorageUnavailableException
    
    ConfNotSupportedException
    
    InvalidSurfaceException
    
    java.net.UnknownHostException
    
    java.io.IOException
  - stop
```
public void stop()
```
    Stops all existing streams.
  - syncStop
```
public void syncStop()
```
    Stops all existing streams in a synchronous manner.
  - startPreview
```
public void startPreview()
```
    Asynchronously starts the camera preview.
    You should of course pass a SurfaceView to setSurfaceView(SurfaceView) before calling this method. Otherwise, the Session.Callback.onSessionError(int, int, Exception) callback will be called with ERROR_INVALID_SURFACE.
  - stopPreview
```
public void stopPreview()
```
    Asynchronously stops the camera preview.
  - switchCamera
```
public void switchCamera()
```
    Switch between the front facing and the back facing camera of the phone.
    If startPreview() has been called, the preview will be briefly interrupted.
    If start() has been called, the stream will be briefly interrupted.
    To find out which camera is currently selected, use getCamera()
  - getCamera
```
public int getCamera()
```
    Returns the id of the camera currently selected.
    It can be either CameraInfo#CAMERA_FACING_BACK or CameraInfo#CAMERA_FACING_FRONT.
  - toggleFlash
```
public void toggleFlash()
```
    Toggles the LED of the phone if it has one. You can get the current state of the flash with getVideoTrack() and VideoStream.getFlashState().
  - release
```
public void release()
```
    Deletes all existing tracks & release associated resources.
  - trackExists
```
public boolean trackExists(int id)
```
  - getTrack
```
public Stream getTrack(int id)
```

Class Session

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG

STREAM_VIDEO

STREAM_AUDIO

ERROR_CAMERA_ALREADY_IN_USE

ERROR_CONFIGURATION_NOT_SUPPORTED

ERROR_STORAGE_NOT_READY

ERROR_CAMERA_HAS_NO_FLASH

ERROR_INVALID_SURFACE

ERROR_UNKNOWN_HOST

ERROR_OTHER

Constructor Detail

Session

Method Detail

getAudioTrack

getVideoTrack

setCallback

setOrigin

setDestination

setTimeToLive

setVideoQuality

setSurfaceView

setPreviewOrientation

setAudioQuality

getCallback

getSessionDescription

getDestination

getBitrate

isStreaming

configure

syncConfigure

start

syncStart

syncStart

stop

syncStop

startPreview

stopPreview

switchCamera

getCamera

toggleFlash

release

trackExists

getTrack