Session

java.lang.Object
- com.SIMRacingApps.Session

Direct Known Subclasses:

iRacingSession
```
public class Session
extends java.lang.Object
```
The class defines access to session level data. There can be different types of sessions, like Practice, Qualifying, Race. The session types are defined by Session.Type.
Each session contains a reference to the Track. The track's instance can be obtained by calling getTrack().
Each session contains references to all the cars, both in the session and not. An instance to a can be obtained by calling getCar(String), where the String defines which car to return. If omitted, it returns the Reference Car.
The session also controls what the reference car is. The default reference car is "ME", but clients can change it. The Reference Car impacts how some lookups for the car are calculated, such as the relative lookups, which means relative to the Reference Car. NOTE: When it's changed, all connected clients will assume the new reference car.

Since:

1.0

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Session.CarIdentifiers` This class enumerates the various car identifiers.
`static class`	`Session.Message` This class enumerates the various messages that a SIM can raise that applies to all cars.
`static class`	`Session.RestartMethod` This class enumerates the values return by `getRestart()` DOUBLEFILE SINGLEFILE
`static class`	`Session.Status` This class enumerates the values return by `getStatus()` UNKNOWN ENGINES_STARTED GREEN CAUTION RED FINISHED
`static class`	`Session.Type` This class enumerates the values returned by `getType()` UNKNOWN OPEN_QUALIFY LONE_QUALIFY OFFLINE OFFLINE_TESTING PRACTICE RACE

Field Summary

Fields
Modifier and Type Field and Description

static int UNLIMITEDLAPS
number of laps to return if the session has unlimited laps

Fields
Modifier and Type	Field and Description
`static int`	`UNLIMITEDLAPS` number of laps to return if the session has unlimited laps

Constructor Summary

Constructors
Constructor and Description

Session(SIMPlugin SIMPlugin)

Constructors
Constructor and Description
`Session(SIMPlugin SIMPlugin)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Data`	`getCamera()` Returns the name of the current camera.
`Data`	`getCameraFocus()` Returns the name of what the camera is focused on.
`Data`	`getCameras()` Returns an array of the camera names for this session.
`Car`	`getCar(java.lang.String carIndentifier)` Returns an instance of a Car object as defined by the "car" argument.
`Data`	`getCars()` Returns the actual number of cars registered for this session.
`Data`	`getCautionLaps()` Returns the number of caution laps.
`Data`	`getCautions()` Returns the number of cautions as seen by the leader.
`Data`	`getClassNames()` Returns an array of the class names sorted fastest to slowest.
`Data`	`getDataVersion()` Returns a SIM specific string indicating the version of the data just returned.
`Data`	`getDiffCars()`
`Data`	`getDiffCars(java.lang.String carIdentifier)`
`Data`	`getDiffCars(java.lang.String carIdentifier1, java.lang.String carIdentifier2)` Returns the difference between 2 cars as either laps or seconds (if on the same lap).
`Data`	`getDiffCarsRelative()`
`Data`	`getDiffCarsRelative(java.lang.String carIdentifier)`
`Data`	`getDiffCarsRelative(java.lang.String carIdentifier1, java.lang.String carIdentifier2)` Calculates the difference between the 2 cars based on their physical distance from each other.
`Data`	`getId()` Returns a SIM specific ID for the current session.
`Data`	`getIncidentLimit()` Returns the total number of incidents allowed for this session.
`Data`	`getIsAppsHidden()` Returns true if the client should hide the App windows.
`Data`	`getIsCautionFlag()` Returns true if the caution flag is waving.
`Data`	`getIsCheckeredFlag()` Returns true if the checkered flag is waving.
`Data`	`getIsCrossedFlag()` Returns true if the crossed flag is waving.
`Data`	`getIsGarageVisible()` Returns true if the garage screen is visible so apps/widgets can hide it.
`Data`	`getIsGreenFlag()` Returns true if the green flag is waving.
`Data`	`getIsPitRoadOpen()` Returns true if pit road is open.
`Data`	`getIsRedFlag()` Returns true if the red flag is waving.
`Data`	`getIsReplay()` Returns true if the session is in replay mode.
`Data`	`getIsReplayLive()` Returns true if the session is in replay mode and has not been rewound to a time in the past.
`Data`	`getIsWhiteFlag()` Returns true if the white flag is waving.
`Data`	`getLap()` Returns the current lap of the race or REFERENCE car if in a different type of session.
`Data`	`getLaps()`
`Data`	`getLaps(java.lang.String sessionType)` Returns the total number of laps in the specified session.
`Data`	`getLapsToGo()` Returns the number of laps to go in sessions that define a total number of laps See `getLaps()`
`Data`	`getLeagueId()` Returns a SIM specific League ID for the current session.
`Data`	`getMessages()` Returns a string of a semicolon separate list of messages that are currently active.
`Data`	`getName()`
`Data`	`getName(java.lang.String session)` Returns the name of the session.
`Data`	`getNumberOfCarClasses()` Returns the number of car classes.
`Data`	`getRadioChannelActive()` Returns the active radio channel.
`Data`	`getRadioChannelIsDeleteable()`
`Data`	`getRadioChannelIsDeleteable(int channel)` Returns if the radio channel can be deleted.
`Data`	`getRadioChannelIsDeleteable(java.lang.String channel)`
`Data`	`getRadioChannelIsListenOnly()`
`Data`	`getRadioChannelIsListenOnly(int channel)` Returns if the radio channel can only be listened to.
`Data`	`getRadioChannelIsListenOnly(java.lang.String channel)`
`Data`	`getRadioChannelIsMutable()`
`Data`	`getRadioChannelIsMutable(int channel)` Returns if the radio channel can be muted.
`Data`	`getRadioChannelIsMutable(java.lang.String channel)`
`Data`	`getRadioChannelIsMuted()`
`Data`	`getRadioChannelIsMuted(int channel)` Returns if the radio channel is currently muted.
`Data`	`getRadioChannelIsMuted(java.lang.String channel)`
`Data`	`getRadioChannelIsScanable()`
`Data`	`getRadioChannelIsScanable(int channel)` Returns if the radio channel can be scanned.
`Data`	`getRadioChannelIsScanable(java.lang.String channel)`
`Data`	`getRadioChannelName()`
`Data`	`getRadioChannelName(int channel)` Returns the radio channel name.
`Data`	`getRadioChannelName(java.lang.String channel)`
`Data`	`getRadioChannels()` Returns the number of radio channels that is scannable by you.
`Data`	`getRadioScan()` Returns the radio's scanning state
`Data`	`getReferenceCar()` Returns the reference car identifier as defined by `getCar(String)`.
`Data`	`getReplay()` Returns the state of the current replay position.
`Data`	`getRestart()` Returns the type of restart, double or single file.
`java.lang.String`	`getSendKeys(java.lang.String group, java.lang.String command)` Returns the string of keys strokes to send to the SIM to issue the command from the group.
`Data`	`getSpotterPitCountDown()` Returns if the SIM has own pit count down spotter enabled.
`Data`	`getStartTime()` Returns the time the current session started as the number of seconds since Jan 1, 1970 UTC.
`Data`	`getStatus()` Returns the status of the session as one of the following defined in `Session.Status`.
`Data`	`getStrengthOfField()` Returns a String that is SIM specific that represents the strength of the field.
`Data`	`getTime()` Returns the time of the current session as the number of seconds since Jan 1, 1970 UTC.
`Data`	`getTimeElapsed()` Returns the number of seconds since the current session started.
`Data`	`getTimeRemaining()` If the current session has a time restriction, this returns the number of seconds remaining.
`Data`	`getTimeString()` Returns the time of the current session in the time zone of the track using the following format.
`Track`	`getTrack()` Returns an instance to the Track in this session Each SIM will have to provide an override that does not return a null
`Data`	`getType()` Returns the type of the current session as defined by `Session.Type`
`Data`	`setAdvanceFlag()` Advance to next Session.
`Data`	`setAppsHidden()`
`Data`	`setAppsHidden(boolean isHidden)` Sets the flag returned by getIsAppsHidden().
`Data`	`setAppsHidden(java.lang.String isHidden)`
`Data`	`setCamera(java.lang.String cameraName)`
`Data`	`setCamera(java.lang.String cameraName, java.lang.String focusOn)`
`Data`	`setCamera(java.lang.String cameraName, java.lang.String focusOn, java.lang.String carIdentifier)` Changes the camera.
`Data`	`setCameraFocus(java.lang.String focusOn)`
`Data`	`setCameraFocus(java.lang.String focusOn, java.lang.String carIdentifier)` Changes the focus of the current camera.
`Data`	`setCautionFlag()` Set Full Course Caution Flag on.
`Data`	`setCautionLaps()`
`Data`	`setCautionLaps(int laps)` Sets the number of caution laps.
`Data`	`setCautionLaps(java.lang.String laps)`
`Data`	`setCautionLapsAdjust()`
`Data`	`setCautionLapsAdjust(int laps)` Add or subtract laps to the current caution laps.
`Data`	`setCautionLapsAdjust(java.lang.String laps)`
`Data`	`setChat(java.lang.String text)` Sends the text string as a chat message to all drivers.
`Data`	`setChatFlag(boolean onOffFlag)` Set Chat on or off for all drivers.
`Data`	`setChatFlag(java.lang.String onOffFlag)`
`Data`	`setChatReply(java.lang.String text)` Sends the text string as a chat message to the last driver to send you a private message.
`Data`	`setPitClose()` Sets the Pits to be closed.
`Data`	`setPitOpen()` Sets the Pits to be open.
`Data`	`setRadioChannel(int channel)` Makes the specified radio channel the active channel to transmit on.
`Data`	`setRadioChannel(java.lang.String channel)`
`Data`	`setRadioChannelDelete(int channel)` Deletes the specified radio channel.
`Data`	`setRadioChannelDelete(java.lang.String channel)`
`Data`	`setRadioChannelMute()`
`Data`	`setRadioChannelMute(int channel, boolean flag)` Mutes or Unmutes the specified radio channel.
`Data`	`setRadioChannelMute(java.lang.String channel)`
`Data`	`setRadioChannelMute(java.lang.String channel, java.lang.String flag)`
`Data`	`setRadioChannelName(java.lang.String channelName)` Makes the specified radio channel the active channel to transmit on.
`Data`	`setRadioScan(boolean flag)` Turns the scanning of the channels on and off, such that, you are only listening on the active channel.
`Data`	`setRadioScan(java.lang.String flag)`
`Data`	`setReferenceCar()`
`Data`	`setReferenceCar(java.lang.String carIdentifier)` Sets the reference car.
`Data`	`setReloadPaint()` Tell the SIM to reload the paint files for all cars.
`Data`	`setReplay(java.lang.String command)` Tells the replay system what to do.
`Data`	`setReplayPosition(java.lang.String command)` Tells the replay system what position to start playing at.
`Data`	`setRestart(java.lang.String command)` Tells the system what type of restart you want.

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

- Field Detail
  - UNLIMITEDLAPS
```
public static final int UNLIMITEDLAPS
```
    number of laps to return if the session has unlimited laps
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Session
```
public Session(SIMPlugin SIMPlugin)
```
- Method Detail
  - getSendKeys
```
public java.lang.String getSendKeys(java.lang.String group,
                                    java.lang.String command)
```
    Returns the string of keys strokes to send to the SIM to issue the command from the group. Each SIM has to override this method and implement it.
    
    Parameters:
    
    group - The group to get the commands from (i.e. ADMIN_COMMANDS, RADIO_COMMANDS)
    
    command - The command within the group to retrieve (i.e. BLACK, ADD)
    
    Returns:
    
    The keys to send to the SIM using the syntax defined by SendKeys
  - getCamera
```
public Data getCamera()
```
    Returns the name of the current camera.
    PATH = /Session/Camera
    
    Returns:
    
    The name of the current camera in a Data container.
    
    Since:
    
    1.3
  - getCameraFocus
```
public Data getCameraFocus()
```
    Returns the name of what the camera is focused on.
    PATH = /Session/CameraFocus
    
    Returns:
    
    The name of what the current camera is focused on in a Data container.
    
    Since:
    
    1.3
  - getCameras
```
public Data getCameras()
```
    Returns an array of the camera names for this session. The camera names are SIM specific and it is not recommended that you assume what the names will be.
    PATH = /Session/Cameras
    
    Returns:
    
    The camera names array in a Data container.
    
    Since:
    
    1.3
  - getCar
```
public Car getCar(java.lang.String carIndentifier)
```
    Returns an instance of a Car object as defined by the "car" argument. SIM implementors should override this method and return a SIM specific car object.
    
    Parameters:
    
    carIndentifier - A string representing the car you want. Values accepted are:
    
    ME
    My Car/Driver information
    
    REFERENCE, R0, RL0, RP0 RPC0
    Defaults to ME, but can be set by the user to any car
    
    PACE, PACECAR, SAFETY, SAFETYCAR, P0, PC0
    The pace car
    
    TRANSMITTING
    The car that is currently talking in SIM or TeamSpeak
    
    LEADER, P1
    The leader
    
    LEADERCLASS, PC1
    The leader of your class
    
    LEADERxxx
    The leader if the same class as xxx
    
    BEST
    The car with the best lap for the entire session
    
    FASTEST
    The car with the fastest last lap
    
    Ixx
    The Car Id xx. Used internally to retrieve cars by Id.
    
    xxx, Nxxx
    The car with this car number
    
    Pxx
    The Car/Driver at position xx. Note: Position 0 should be the pace car in sessions that have a pace car
    
    PCxx
    The Car/Driver at position xx in your class. Note: Position 0 should be the pace car in sessions that have a pace car
    
    R-/+xx
    The Car/Driver relative to REFERENCE by location in the session. Example: R-1 driver behind, R+1 driver ahead
    
    RC-/+xx
    The Car/Driver relative to REFERENCE by location in the session for the same class as the reference car. Example: RC-1 driver behind in class, RC+1 driver ahead in class
    
    RL-/+xx
    The Car/Driver relative to REFERENCE by location segregated by On Pit Road and On Track. Example: RL-1 driver behind, RL+1 driver ahead
    
    RLC-/+xx
    The Car/Driver relative to REFERENCE by location in the same class as the reference car segregated by On Pit Road and On Track. Example: RLC-1 driver behind in class, RLC+1 driver ahead in class
    
    RP-/+xx
    The Car/Driver relative to REFERENCE by position. Example: RP-1 driver behind, RP+1 driver ahead
    
    RPCxx
    The Car/Driver at position xx by relative position by class. Example: RPC-1 driver behind, RPC+1 driver ahead in same class
    
    Returns:
    
    An instance of Car
  - getCars
```
public Data getCars()
```
    Returns the actual number of cars registered for this session. It does not count the pace car or ghost cars.
    PATH = /Session/Cars
    
    Returns:
    
    The number of cars in a Data container.
  - getCautionLaps
```
public Data getCautionLaps()
```
    Returns the number of caution laps.
    PATH = /Session/CautionLaps
    
    Returns:
    
    The number of caution laps in a Data container.
  - getCautions
```
public Data getCautions()
```
    Returns the number of cautions as seen by the leader.
    PATH = /Session/Cautions
    
    Returns:
    
    The number of cautions in a Data container.
  - getClassNames
```
public Data getClassNames()
```
    Returns an array of the class names sorted fastest to slowest.
    PATH = /Session/ClassNames
    
    Returns:
    
    The class names array in a Data container.
  - getDataVersion
```
public Data getDataVersion()
```
    Returns a SIM specific string indicating the version of the data just returned. Do not make any assumptions of how this is formatted. Assume it's just a printable string.
    PATH = /Session/DataVersion
    
    Returns:
    
    The version in a Data container.
  - getDiffCars
```
public Data getDiffCars(java.lang.String carIdentifier1,
                        java.lang.String carIdentifier2)
```
    Returns the difference between 2 cars as either laps or seconds (if on the same lap). If the 2 cars are the same car, then returns the last lap time or the total session time if the checkered flag is out.
    This sign of the result will be car2 is behind car1, where car2 is the REFERENCE car and car1 is the LEADER, it will return seconds/laps behind as a negative number.
    PATH = /Session/DiffCars/(CARIDENTIFIER1)/(CARIDENTIFIER2)
    
    Parameters:
    
    carIdentifier1 - Car as defined by getCar(String), default LEADERxxx.
    
    carIdentifier2 - Car as defined by getCar(String), default REFERENCE.
    
    Returns:
    
    The difference in seconds or laps in a Data container.
  - getDiffCars
```
public Data getDiffCars(java.lang.String carIdentifier)
```
  - getDiffCars
```
public Data getDiffCars()
```
  - getDiffCarsRelative
```
public Data getDiffCarsRelative(java.lang.String carIdentifier1,
                                java.lang.String carIdentifier2)
```
    Calculates the difference between the 2 cars based on their physical distance from each other. This differs from getDiffCars() by the fact it uses the way that car1 and car2 are named to determine position.
    PATH = /Session/DiffCarsRelative/(CARIDENTIFIER1)/(CARIDENTIFIER2)
    
    Parameters:
    
    carIdentifier1 - Car as defined by getCar(String)
    
    carIdentifier2 - Car as defined by getCar(String)
    
    Returns:
    
    The difference in seconds in a Data container.
  - getDiffCarsRelative
```
public Data getDiffCarsRelative(java.lang.String carIdentifier)
```
  - getDiffCarsRelative
```
public Data getDiffCarsRelative()
```
  - getId
```
public Data getId()
```
    Returns a SIM specific ID for the current session.
    PATH = /Session/Id 1.2
    
    Returns:
    
    The Id in a Data container.
    
    Since:
    
    1.2
  - getIncidentLimit
```
public Data getIncidentLimit()
```
    Returns the total number of incidents allowed for this session. If the session does not specify them, such as, practice, then 9999 is returned. Different SIMs may measure these in different units of measure. The default is "x".
    PATH = /Session/IncidentLimit
    
    Returns:
    
    The incident limit in a Data container.
  - getIsAppsHidden
```
public Data getIsAppsHidden()
```
    Returns true if the client should hide the App windows.
    PATH = /Session/IsAppsHidden
    
    Returns:
    
    true if the Apps should be hidden Data container.
  - getIsGarageVisible
```
public Data getIsGarageVisible()
```
    Returns true if the garage screen is visible so apps/widgets can hide it.
    PATH = /Session/IsGarageVisible
    
    Returns:
    
    true if the garage screen is visible in a Data container.
  - getIsGreenFlag
```
public Data getIsGreenFlag()
```
    Returns true if the green flag is waving.
    PATH = /Session/IsGreenFlag
    
    Returns:
    
    true if the green flag is out in a Data container.
  - getIsCautionFlag
```
public Data getIsCautionFlag()
```
    Returns true if the caution flag is waving.
    PATH = /Session/IsCautionFlag
    
    Returns:
    
    true if the caution flag is out in a Data container.
  - getIsCheckeredFlag
```
public Data getIsCheckeredFlag()
```
    Returns true if the checkered flag is waving.
    PATH = /Session/IsCheckeredFlag
    
    Returns:
    
    true if the checkered flag is out in a Data container.
  - getIsCrossedFlag
```
public Data getIsCrossedFlag()
```
    Returns true if the crossed flag is waving. This generally means the leader has passed the halfway point.
    PATH = /Session/IsCrossedFlag
    
    Returns:
    
    true if the crossed flag is out in a Data container.
  - getIsWhiteFlag
```
public Data getIsWhiteFlag()
```
    Returns true if the white flag is waving.
    PATH = /Session/IsWhiteFlag
    
    Returns:
    
    true if the white flag is out in a Data container.
  - getIsRedFlag
```
public Data getIsRedFlag()
```
    Returns true if the red flag is waving.
    PATH = /Session/IsRedFlag
    
    Returns:
    
    true if the green flag is out in a Data container.
  - getIsPitRoadOpen
```
public Data getIsPitRoadOpen()
```
    Returns true if pit road is open.
    PATH = /Session/IsPitRoadOpen
    
    Returns:
    
    true if the pits are open in a Data container.
  - getIsReplay
```
public Data getIsReplay()
```
    Returns true if the session is in replay mode. Otherwise, false which assumes all data is live (real-time).
    PATH = /Session/IsReplay
    
    Returns:
    
    true if the green flag is out in a Data container.
  - getIsReplayLive
```
public Data getIsReplayLive()
```
    Returns true if the session is in replay mode and has not been rewound to a time in the past. Otherwise, false which assumes the replay is not live and is running in the past. NOTE: If getIsReplay() returns false, then the status of this is set to OFF and the value returned is false. So check the status to be NORMAL if in replay mode.
    PATH = /Session/IsReplayLive
    
    Returns:
    
    true if the green flag is out in a Data container.
  - getLap
```
public Data getLap()
```
    Returns the current lap of the race or REFERENCE car if in a different type of session.
    Current lap is defined as the lap you are about to complete. Meaning that, if you're on lap 1, you just took the green flag.
    PATH = /Session/Lap
    
    Returns:
    
    The current lap in a Data container.
  - getLaps
```
public Data getLaps(java.lang.String sessionType)
```
    Returns the total number of laps in the specified session. If the session does not specify them, such as, practice, then 9999 is returned or estimated based on time remaining. Sometimes, sessions are timed and it is not defined. In this case, the laps will be estimated based on the leaders average lap time. If the specified session does not exist, then the State will be set to OFF and zero returned.
    PATH = /Session/Laps/(SESSIONTYPE)
    
    Parameters:
    
    sessionType - The session type, Session.Type, to get the laps from. Defaults to current session.
    
    Returns:
    
    The number of laps in a Data container.
  - getLaps
```
public Data getLaps()
```
  - getLapsToGo
```
public Data getLapsToGo()
```
    Returns the number of laps to go in sessions that define a total number of laps See getLaps()
    PATH = /Session/LapsToGo
    
    Returns:
    
    The number of laps to go in a Data container.
  - getLeagueId
```
public Data getLeagueId()
```
    Returns a SIM specific League ID for the current session.
    PATH = /Session/LeagueId 1.2
    
    Returns:
    
    The League Id in a Data container.
    
    Since:
    
    1.2
  - getMessages
```
public Data getMessages()
```
    Returns a string of a semicolon separate list of messages that are currently active. It is possible to have multiple messages. Each message will have a semicolon before and after it, even at the begin and end of the string. Possible message values are determined by Session.Message. You can display as is, or use it as an index to the the translation for a particular language.
    For example: ";ONELAPTOGREEN;"
    PATH = /Session/Messages
    
    Returns:
    
    A list of messages in a Data container.
  - getName
```
public Data getName(java.lang.String session)
```
    Returns the name of the session. This name is SIM dependent and should not be used for decision making, only display.
    PATH = /Session/Name/(session)
    
    Parameters:
    
    session - (optional) The session identifier. Defaults to current session.
    
    Returns:
    
    A list of messages in a Data container.
  - getName
```
public Data getName()
```
  - getNumberOfCarClasses
```
public Data getNumberOfCarClasses()
```
    Returns the number of car classes. See getNumberOfCarClasses()
    PATH = /Session/NumberOfCarClasses
    
    Returns:
    
    The number of laps to go in a Data container.
  - getRadioChannels
```
public Data getRadioChannels()
```
    Returns the number of radio channels that is scannable by you.
    PATH = /Session/RadioChannels
    
    Returns:
    
    The number of radio channels available in a Data container.
  - getRadioChannelActive
```
public Data getRadioChannelActive()
```
    Returns the active radio channel.
    PATH = /Session/RadioChannelActive
    
    Returns:
    
    The active channel in a Data container.
  - getRadioChannelIsDeleteable
```
public Data getRadioChannelIsDeleteable(int channel)
```
    Returns if the radio channel can be deleted.
    PATH = /Session/RadioChannelIsDeletable/(CHANNELNUMBER)
    
    Parameters:
    
    channel - (Optional) The channel number. Defaults to the active channel.
    
    Returns:
    
    Y if deleteable, N if not in a Data container.
  - getRadioChannelIsDeleteable
```
public Data getRadioChannelIsDeleteable(java.lang.String channel)
```
  - getRadioChannelIsDeleteable
```
public Data getRadioChannelIsDeleteable()
```
  - getRadioChannelIsListenOnly
```
public Data getRadioChannelIsListenOnly(int channel)
```
    Returns if the radio channel can only be listened to. N means that you can also transmit on this channel.
    PATH = /Session/RadioChannelIsListenOnly/(CHANNELNUMBER)
    
    Parameters:
    
    channel - (Optional) The channel number. Defaults to the active channel.
    
    Returns:
    
    Y if listen only, N if you can also transmit in a Data container.
  - getRadioChannelIsListenOnly
```
public Data getRadioChannelIsListenOnly(java.lang.String channel)
```
  - getRadioChannelIsListenOnly
```
public Data getRadioChannelIsListenOnly()
```
  - getRadioChannelIsMutable
```
public Data getRadioChannelIsMutable(int channel)
```
    Returns if the radio channel can be muted.
    PATH = /Session/RadioChannelIsMutable/(CHANNELNUMBER)
    
    Parameters:
    
    channel - (Optional) The channel number. Default to the active channel.
    
    Returns:
    
    Y if muteable, N if not in a Data container.
  - getRadioChannelIsMutable
```
public Data getRadioChannelIsMutable(java.lang.String channel)
```
  - getRadioChannelIsMutable
```
public Data getRadioChannelIsMutable()
```
  - getRadioChannelIsMuted
```
public Data getRadioChannelIsMuted(int channel)
```
    Returns if the radio channel is currently muted.
    PATH = /Session/RadioChannelIsMuted/(CHANNELNUMBER)
    
    Parameters:
    
    channel - (Optional) The channel number. Defaults to the active channel.
    
    Returns:
    
    Y if muted, N if not in a Data container.
  - getRadioChannelIsMuted
```
public Data getRadioChannelIsMuted(java.lang.String channel)
```
  - getRadioChannelIsMuted
```
public Data getRadioChannelIsMuted()
```
  - getRadioChannelIsScanable
```
public Data getRadioChannelIsScanable(int channel)
```
    Returns if the radio channel can be scanned.
    PATH = /Session/RadioChannelIsScanable/(CHANNELNUMBER)
    
    Parameters:
    
    channel - (Optional) The channel number. Defaults to the active channel.
    
    Returns:
    
    Y if scanable, N if not in a Data container.
  - getRadioChannelIsScanable
```
public Data getRadioChannelIsScanable(java.lang.String channel)
```
  - getRadioChannelIsScanable
```
public Data getRadioChannelIsScanable()
```
  - getRadioChannelName
```
public Data getRadioChannelName(int channel)
```
    Returns the radio channel name.
    PATH = /Session/RadioChannelName/(CHANNELNUMBER)
    
    Parameters:
    
    channel - (Optional) The channel number. Defaults to the active channel.
    
    Returns:
    
    name of the radio channel in a Data container.
  - getRadioChannelName
```
public Data getRadioChannelName(java.lang.String channel)
```
  - getRadioChannelName
```
public Data getRadioChannelName()
```
  - getRadioScan
```
public Data getRadioScan()
```
    Returns the radio's scanning state
    PATH = /Session/RadioScan
    
    Returns:
    
    Y if radio is scanning, N if not in a Data container.
  - setRadioChannel
```
public Data setRadioChannel(int channel)
```
    Makes the specified radio channel the active channel to transmit on. If you cannot transmit on this channel, it does not change the active channel.
    PATH = /Session/setRadioChannel/(CHANNELNUMBER)
    
    Parameters:
    
    channel - The channel number.
    
    Returns:
    
    the active channel number in a Data container.
  - setRadioChannel
```
public Data setRadioChannel(java.lang.String channel)
```
  - setRadioChannelDelete
```
public Data setRadioChannelDelete(int channel)
```
    Deletes the specified radio channel.
    PATH = /Session/setRadioChannelDelete/(CHANNELNUMBER)
    
    Parameters:
    
    channel - The channel number.
    
    Returns:
    
    the channel number deleted in a Data container.
  - setRadioChannelDelete
```
public Data setRadioChannelDelete(java.lang.String channel)
```
  - setRadioChannelMute
```
public Data setRadioChannelMute(int channel,
                                boolean flag)
```
    Mutes or Unmutes the specified radio channel.
    PATH = /Session/setRadioChannelMute/(CHANNELNUMBER)/(Y/N)
    
    Parameters:
    
    channel - (Optional) The channel number. Defaults to the active channel.
    
    flag - (Optional) Y to mute, N to unmute. Default is Y.
    
    Returns:
    
    the channel number muted in a Data container.
  - setRadioChannelMute
```
public Data setRadioChannelMute(java.lang.String channel,
                                java.lang.String flag)
```
  - setRadioChannelMute
```
public Data setRadioChannelMute(java.lang.String channel)
```
  - setRadioChannelMute
```
public Data setRadioChannelMute()
```
  - setRadioChannelName
```
public Data setRadioChannelName(java.lang.String channelName)
```
    Makes the specified radio channel the active channel to transmit on. If the channel does not exist, an attempt to create the channel is done. If the channel already exists, and you can transmit on it, it will join that channel and make it the active channel.
    PATH = /Session/setRadioChannelName/(CHANNELNAME)
    
    Parameters:
    
    channelName - The channel name, limited to 15 characters.
    
    Returns:
    
    the channel name in a Data container.
  - setRadioScan
```
public Data setRadioScan(boolean flag)
```
    Turns the scanning of the channels on and off, such that, you are only listening on the active channel. Some channels may not turn off based on the SIM, such as, RACECONTROL or ADMIN channels.
    PATH = /Session/setRadioScan/(Y/N)
    
    Parameters:
    
    flag - Y to enable scanning, N to disable scanning
    
    Returns:
    
    flag in a Data container.
  - setRadioScan
```
public Data setRadioScan(java.lang.String flag)
```
  - getReplay
```
public Data getReplay()
```
    Returns the state of the current replay position.
    
    >
    Playing at Normal Speed
    
    << {speed}x
    Rewinding
    
    >> {speed}x
    Fast Forwarding
    
    ||
    Paused
    
    PATH = /Session/Replay
    
    Returns:
    
    A string representing the replay state in a Data container.
    
    Since:
    
    1.3
  - getRestart
```
public Data getRestart()
```
    Returns the type of restart, double or single file.
    PATH = /Session/Restart
    
    Returns:
    
    A string representing the restart type in a Data container.
    
    Since:
    
    1.20
  - setReplay
```
public Data setReplay(java.lang.String command)
```
    Tells the replay system what to do. Note, some SIMs require you to get out of the car first.
    
    PLAY, >
    Start Playing at Normal Speed
    
    REWIND, RW, <, <<
    Start Rewinding. Multiple presses will go faster.
    
    FASTFORWARD, FF, >>
    Start Fast Forwarding. Multiple presses will go faster.
    
    PAUSE, ||
    Pause the replay
    
    SLOWMOTION, SM, |>
    Slow down the replay play back speed in the current direction. Multiple presses will go slower.
    
    PATH = /Session/setReplay/(COMMAND)
    
    Parameters:
    
    command - The command to execute. Defaults to PLAY.
    
    Returns:
    
    The speed the replay is currently playing at in a Data container.
    
    Since:
    
    1.3
  - setReplayPosition
```
public Data setReplayPosition(java.lang.String command)
```
    Tells the replay system what position to start playing at. Here are the available commands.
    
    BEGINNING, START
    Start Playing at the beginning
    
    ENDING, END
    Go to end of replay. If in a session, should take you back to live.
    
    NEXTFRAME, NEXT
    Go to the next frame
    
    PREVFRAME, PREV
    Go to the previous frame
    
    NEXTLAP
    Go to the next lap
    
    PREVLAP
    Go to the previous lap
    
    NEXTCRASH
    Go to the next crash
    
    PREVCRASH
    Go to the previous crash
    
    NEXTSESSION
    Go to the next session, Practice, Qualifying, Race
    
    PREVSESSION
    Go to the previous session, Practice, Qualifying, Race
    
    FORWARD15
    Go forward 15 seconds
    
    BACKWARD15
    Go backwards 15 seconds
    
    FORWARD30
    Go forward 30 seconds
    
    BACKWARD30
    Go backwards 30 seconds
    
    FORWARD60
    Go forward 60 seconds
    
    BACKWARD80
    Go backwards 60 seconds
    
    PATH = /Session/setReplayPosition/(COMMAND)
    
    Parameters:
    
    command - The position to go to.
    
    Returns:
    
    The speed the replay is currently playing at in a Data container.
    
    Since:
    
    1.3
  - setRestart
```
public Data setRestart(java.lang.String command)
```
    Tells the system what type of restart you want.
    
    DOUBLEFILE
    Restart Double File
    
    SINGLEFILE
    Restart Single File
    
    PATH = /Session/setRestart/(COMMAND)
    
    Parameters:
    
    command - The restart method.
    
    Returns:
    
    The restart method in a Data container.
    
    Since:
    
    1.20
  - getSpotterPitCountDown
```
public Data getSpotterPitCountDown()
```
    Returns if the SIM has own pit count down spotter enabled.
    PATH = /Session/SpotterPitCountDown
    
    Returns:
    
    Y if SIM is counting down, N if not in a Data container.
  - getStartTime
```
public Data getStartTime()
```
    Returns the time the current session started as the number of seconds since Jan 1, 1970 UTC. It may be adjusted by the SIM to reflect a virtual date/time being simulated. But, that will be in UTC as well. The offset of the time zone is in the State in the format of +/-HHMM. You can use the com.SIMRacingApps.Track.getTimeZone() to display the track's time zone, but to convert to the time zone of the track use the offset returned in the Data.State field. This will account for daylight savings time.
    PATH = /Session/StartTime
    
    Returns:
    
    The start time in a Data container.
  - getStatus
```
public Data getStatus()
```
    Returns the status of the session as one of the following defined in Session.Status.
    - UNKNOWN
    - ENGINES_STARTED
    - GREEN
    - CAUTION
    - RED
    - FINISHED
    PATH = /Session/Status 1.12
    Returns:
    
    The status in a Data container.
    
    Since:
    
    1.12
  - getStrengthOfField
```
public Data getStrengthOfField()
```
    Returns a String that is SIM specific that represents the strength of the field. This implies a SIM has some sort of ranking system. Do not assume a specific format of this string. It is for display purposes only.
    PATH = /Session/StrengthOfField
    
    Returns:
    
    The strength of the field in a Data container.
  - getTime
```
public Data getTime()
```
    Returns the time of the current session as the number of seconds since Jan 1, 1970 UTC. It may be adjusted by the SIM to reflect a virtual date/time being simulated. But, that will be in UTC as well. The offset of the time zone is in the State in the format of +/-HHMM. You can use the com.SIMRacingApps.Track.getTimeZone() to display the track's time zone, but to convert to the time zone of the track use the offset returned in the Data.State field. This will account for daylight savings time.
    PATH = /Session/Time
    
    Returns:
    
    The start time in a Data container.
  - getTimeString
```
public Data getTimeString()
```
    Returns the time of the current session in the time zone of the track using the following format. YYYYMMDDHHMMSS It may be adjusted by the SIM to reflect a virtual date/time being simulated. You can use the com.SIMRacingApps.Track.getTimeZone() to display the track's time zone.
    PATH = /Session/TimeString
    
    Returns:
    
    The start time in a Data container.
  - getTimeElapsed
```
public Data getTimeElapsed()
```
    Returns the number of seconds since the current session started.
    PATH = /Session/TimeElapsed
    
    Returns:
    
    The number of seconds in current session in a Data container.
  - getTimeRemaining
```
public Data getTimeRemaining()
```
    If the current session has a time restriction, this returns the number of seconds remaining. If the session is laps bound and the laps to go is not estimated, then the time remaining will be estimated. If there is no time restriction, then the time is estimated based on the leader's average lap times. The UOM will be prefixed with a tilde(~) to indicate it is an approximate time.
    PATH = /Session/TimeRemaining
    
    Returns:
    
    The number of seconds remaining in a Data container.
  - getTrack
```
public Track getTrack()
```
    Returns an instance to the Track in this session Each SIM will have to provide an override that does not return a null
    
    Returns:
    
    An instance of Track
  - getType
```
public Data getType()
```
    Returns the type of the current session as defined by Session.Type
    PATH = /Session/Type
    
    Returns:
    
    The session type in a Data container.
  - getReferenceCar
```
public Data getReferenceCar()
```
    Returns the reference car identifier as defined by getCar(String). The default reference car is "ME", but can be changed by calling setReferenceCar(String)
    PATH = /Session/ReferenceCar
    
    Returns:
    
    The reference car identifier in a Data container.
  - setAdvanceFlag
```
public Data setAdvanceFlag()
```
    Advance to next Session. This will tell the SIM go to the next session, practice to qualify to grid to end of race. This command is SIM specific and requires special privileges to succeed.
    PATH = /Session/setAdvanceFlag
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setAppsHidden
```
public Data setAppsHidden(boolean isHidden)
```
    Sets the flag returned by getIsAppsHidden().
    PATH = /Session/setAppsHidden
    
    Parameters:
    
    isHidden - true to hide the apps, false to unhide them
    
    Returns:
    
    The apps hidden state in a Data container.
  - setAppsHidden
```
public Data setAppsHidden(java.lang.String isHidden)
```
  - setAppsHidden
```
public Data setAppsHidden()
```
  - setCamera
```
public Data setCamera(java.lang.String cameraName,
                      java.lang.String focusOn,
                      java.lang.String carIdentifier)
```
    Changes the camera. This is very SIM specific. Some SIMs can do this, others cannot. The name of the camera is very SIM specific. Some SIMs limit the camera you can choose based on if you are driving or spectating or watching a replay. So, if the SIM doesn't allow the change, then this function will not really know. Therefore, there I cannot detect an error condition.
    PATH = /Session/setCamera/(CAMERA)/(FOCUSON)/(CARIDENTIFIER)
    
    Parameters:
    
    cameraName - The name of the camera. Can be the string CURRENT or blank to use the currently selected camera.
    
    focusOn - (Optional) What to focus on. Valid values are (CRASHES,LEADER,EXCITING,DRIVER). Default is DRIVER.
    
    carIdentifier - (Optional) A car identifier as defined by getCar(String). Default is REFERENCE.
    
    Returns:
    
    The camera name in a Data container.
    
    Since:
    
    1.3
  - setCamera
```
public Data setCamera(java.lang.String cameraName,
                      java.lang.String focusOn)
```
  - setCamera
```
public Data setCamera(java.lang.String cameraName)
```
  - setCameraFocus
```
public Data setCameraFocus(java.lang.String focusOn,
                           java.lang.String carIdentifier)
```
    Changes the focus of the current camera. This is very SIM specific. Some SIMs can do this, others cannot. The name of the camera is very SIM specific. Some SIMs limit the camera you can choose based on if you are driving or spectating or watching a replay. So, if the SIM doesn't allow the change, then this function will not really know. Therefore, there I cannot detect an error condition.
    PATH = /Session/setCamera/(FOCUSON)/(CARIDENTIFIER)
    
    Parameters:
    
    focusOn - What to focus on. Valid values are (CRASHES,LEADER,EXCITING,DRIVER). Default is DRIVER.
    
    carIdentifier - (Optional) A car identifier as defined by getCar(String). Default is REFERENCE.
    
    Returns:
    
    The camera name in a Data container.
  - setCameraFocus
```
public Data setCameraFocus(java.lang.String focusOn)
```
  - setChat
```
public Data setChat(java.lang.String text)
```
    Sends the text string as a chat message to all drivers. Each SIM must override this method and provide this functionality.
    PATH = /Session/setChat/(TEXT)
    
    Parameters:
    
    text - The text to send to the chat window
    
    Returns:
    
    The text string sent to the drivers in a Data container.
  - setChatReply
```
public Data setChatReply(java.lang.String text)
```
    Sends the text string as a chat message to the last driver to send you a private message. Each SIM must override this method and provide this functionality.
    PATH = /Session/setChatReply/(TEXT)
    
    Parameters:
    
    text - The text to send to the chat window
    
    Returns:
    
    The text string sent to the drivers in a Data container.
  - setChatFlag
```
public Data setChatFlag(boolean onOffFlag)
```
    Set Chat on or off for all drivers. This command is SIM specific and requires special privileges to succeed.
    PATH = /Session/setChatFlag/(Y/N)
    
    Parameters:
    
    onOffFlag - Y/N to turn chat on or off for all drivers.
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setChatFlag
```
public Data setChatFlag(java.lang.String onOffFlag)
```
  - setReferenceCar
```
public Data setReferenceCar(java.lang.String carIdentifier)
```
    Sets the reference car.
    PATH = /Session/setReferenceCar/(CARIDENTIFIER)
    
    Parameters:
    
    carIdentifier - A car identifier as defined by getCar(String). You cannot set the reference car to "REFERENCE". Default to "ME".
    
    Returns:
    
    The reference car identifier in a Data container.
  - setReferenceCar
```
public Data setReferenceCar()
```
  - setCautionFlag
```
public Data setCautionFlag()
```
    Set Full Course Caution Flag on. You cannot turn it off once it is issued. This command is SIM specific and requires special privileges to succeed.
    PATH = /Session/setCautionFlag
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setCautionLaps
```
public Data setCautionLaps(int laps)
```
    Sets the number of caution laps. Default is 2 laps. This command is SIM specific and requires special privileges to succeed.
    PATH = /Session/setCautionLaps/(LAPS)
    
    Parameters:
    
    laps - The number of laps for the caution.
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setCautionLaps
```
public Data setCautionLaps(java.lang.String laps)
```
  - setCautionLaps
```
public Data setCautionLaps()
```
  - setCautionLapsAdjust
```
public Data setCautionLapsAdjust(int laps)
```
    Add or subtract laps to the current caution laps. Default is to add 1 lap. This command is SIM specific and requires special privileges to succeed.
    PATH = /Session/setCautionLapsAdjust/(LAPS)
    
    Parameters:
    
    laps - +/- the number of laps to add to the current caution laps.
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setCautionLapsAdjust
```
public Data setCautionLapsAdjust(java.lang.String laps)
```
  - setCautionLapsAdjust
```
public Data setCautionLapsAdjust()
```
  - setPitClose
```
public Data setPitClose()
```
    Sets the Pits to be closed. This command is SIM specific and requires special privileges to succeed.
    PATH = /Session/setPitClose
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setPitOpen
```
public Data setPitOpen()
```
    Sets the Pits to be open. This command is SIM specific and requires special privileges to succeed.
    PATH = /Session/setPitOpen
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setReloadPaint
```
public Data setReloadPaint()
```
    Tell the SIM to reload the paint files for all cars. If SIM does not support this capability, then the NOTAVAILABLE state will be returned.
    PATH = /Session/setReloadPaint
    
    Returns:
    
    The string sent to SIM in a Data container.

Class Session

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNLIMITEDLAPS

Constructor Detail

Session

Method Detail

getSendKeys

getCamera

getCameraFocus

getCameras

getCar

getCars

getCautionLaps

getCautions

getClassNames

getDataVersion

getDiffCars

getDiffCars

getDiffCars

getDiffCarsRelative

getDiffCarsRelative

getDiffCarsRelative

getId

getIncidentLimit

getIsAppsHidden

getIsGarageVisible

getIsGreenFlag

getIsCautionFlag

getIsCheckeredFlag

getIsCrossedFlag

getIsWhiteFlag

getIsRedFlag

getIsPitRoadOpen

getIsReplay

getIsReplayLive

getLap

getLaps

getLaps

getLapsToGo

getLeagueId

getMessages

getName

getName

getNumberOfCarClasses

getRadioChannels

getRadioChannelActive

getRadioChannelIsDeleteable

getRadioChannelIsDeleteable

getRadioChannelIsDeleteable

getRadioChannelIsListenOnly

getRadioChannelIsListenOnly

getRadioChannelIsListenOnly

getRadioChannelIsMutable

getRadioChannelIsMutable

getRadioChannelIsMutable

getRadioChannelIsMuted

getRadioChannelIsMuted

getRadioChannelIsMuted

getRadioChannelIsScanable

getRadioChannelIsScanable

getRadioChannelIsScanable

getRadioChannelName

getRadioChannelName

getRadioChannelName

getRadioScan

setRadioChannel

setRadioChannel

setRadioChannelDelete

setRadioChannelDelete

setRadioChannelMute

setRadioChannelMute

setRadioChannelMute

setRadioChannelMute

setRadioChannelName

setRadioScan