CastSession (JxBrowser 7.43.1 API)

All Superinterfaces:

Observable<CastSessionStopped>
```
public interface CastSession
extends Observable<CastSessionStopped>
```
A session of casting media content to a media receiver.
The session is discovered when the user starts casting the browser/screen content or a presentation of media content via the JxBrowser API, or another application, i.e. Google Chrome. To indicate that the cast session has been started by another profile and, accordingly, a Chromium instance the isLocal() method is provided.

Since:

7.29

See Also:

CastSessionStopped, Browser.cast(MediaReceiver), Browser.castScreen(MediaReceiver), Browser.castScreen(MediaReceiver, ScreenCastOptions), StartPresentationCallback

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`description()` Returns the description of the session.
`boolean`	`isAlive()` Returns `true` if the session is alive.
`boolean`	`isLocal()` Returns `true` if the cast session is initiated and managed by the current profile.
`MediaReceiver`	`mediaReceiver()` Returns the media receiver of this session.
`CastMode`	`mode()` Returns the mode of the session.
`Profile`	`profile()` Returns the profile that discovered this cast session.
`void`	`stop()` Stops this cast session.

Methods inherited from interface com.teamdev.jxbrowser.event.Observable
on

- Method Detail
  - mediaReceiver
```
MediaReceiver mediaReceiver()
```
    Returns the media receiver of this session.
    The method may block the current thread if the receiver is not discovered yet. It may happen when the cast session is not isLocal() local} and started on the receiver not yet discovered by the current instance of Chromium.
    
    Throws:
    
    ObjectClosedException - when the profile is deleted or its engine is closed
    
    ReceiverNotDiscoveredException - when the receiver has not been discovered within 45 seconds
  - mode
```
CastMode mode()
```
    Returns the mode of the session.
    
    Throws:
    
    ObjectClosedException - when the profile is deleted or its engine is closed
  - description
```
java.lang.String description()
```
    Returns the description of the session. Examples: "Mirroring tab (www.example.com)", "Casting media", "Casting YouTube".
    The description may be empty when the session just started and Chromium didn't define the cast content yet.
    
    Throws:
    
    ObjectClosedException - when the profile is deleted or its engine is closed
  - stop
```
void stop()
```
    Stops this cast session.
    Does nothing if the cast session is already stopped.
    
    Throws:
    
    ObjectClosedException - when the profile is deleted or its engine is closed
  - isAlive
```
boolean isAlive()
```
    Returns true if the session is alive.
    
    Throws:
    
    ObjectClosedException - when the profile is deleted or its engine is closed
  - isLocal
```
boolean isLocal()
```
    Returns true if the cast session is initiated and managed by the current profile.
    
    Throws:
    
    ObjectClosedException - when the profile is deleted or its engine is closed
  - profile
```
Profile profile()
```
    Returns the profile that discovered this cast session.
    If the session is not local then this is not the profile that started the session.

Interface CastSession

Method Summary

Methods inherited from interface com.teamdev.jxbrowser.event.Observable

Method Detail

mediaReceiver

mode

description

stop

isAlive

isLocal

profile