
# The `session` object

The `session` object is a single live streaming session. It is an especially
important Livepeer.com API object if need to reference recorded live stream
sessions.

All `session` objects have a `stream` object parent. The session's `parentId` is
the same string as its parent stream's `id`.

All `session` objects are read-only. Many `session` parameter values are
inherited directly from its `stream` parent, for example `profiles`, `record`,
`streamKey` and `playbackId` (all sessions with the same `parentId` use the same
`streamKey` and have the same .m3u8 playback URL).

Other `session` parameter values are unique to it, for example `id`, ingested
`sourceSegments`, duration data, and `recordingUrl` among others.

## Attributes

<Table
  data={[
    {
      parameter: <code>createdAt</code>,
      type: <code>number</code>,
      description:
        "Timestamp when the session was created. Reported in Unix epoch time.",
    },
    {
      parameter: <code>createdByTokenName</code>,
      type: <code>string</code>,
      description:
        "Livepeer.com user-assigned name for the API key that created the stream object.",
    },
    {
      parameter: <code>id</code>,
      type: <code>string</code>,
      description: "Unique identifier for the session.",
    },
    {
      parameter: <code>isActive</code>,
      type: <code>boolean</code>,
      description: (
        <span>
          <code>true</code> while the session is active and up to about five
          minutes after it has ended. <code>false</code> after that."
        </span>
      ),
    },
    {
      parameter: <code>kind</code>,
      type: <code>string</code>,
      description: "Livepeer.com API object type.",
    },
    {
      parameter: <code>lastSeen</code>,
      type: <code>number</code>,
      description:
        "Timestamp when video was last ingested for the session. Reported in Unix epoch time.",
    },
    {
      parameter: <code>name</code>,
      type: <code>string</code>,
      description: "Additional identifier for the asset. Not customizable.",
    },
    {
      parameter: <code>parentId</code>,
      type: <code>string</code>,
      description:
        "Points to a parent stream object. The session's parentId is the same string as its parent stream's id.",
    },
    {
      parameter: <code>playbackId</code>,
      type: <code>string</code>,
      description:
        "Unique identifier used to form the live stream playback URL. All sessions with the same parentId have the same .m3u8 playback URL.",
    },
    {
      parameter: <code>profiles</code>,
      type: <code>array</code>,
      description:
        "Transcoding rendition settings, inherited from the parent stream profiles. The source will be delivered with the renditions in the HLS and does not need to be redefined in the profiles parameter. If no profiles are defined, only the source will be delivered for playback.",
    },
    {
      parameter: <code>record</code>,
      type: <code>boolean</code>,
      description:
        "true means the session is being recorded or was recorded. false means the session is not being recorded or was not recorded. IMPORTANT: If you change the parent stream record value, the new setting will only apply to future sessions, but not the active session.",
    },
    {
      parameter: <code>recordingStatus</code>,
      type: <code>string</code>,
      description:
        "Appears only if record is true. It is either ready when the recorded live stream is available for playback or waiting while the livestream is still active or just recently completed.",
    },
    {
      parameter: <code>recordingURL</code>,
      type: <code>string</code>,
      description:
        "Appears only if record is true and when recordingStatus changes to ready. Its value is the .m3u8 URL to stream the recorded session.",
    },
    {
      parameter: <code>sourceSegments</code>,
      type: <code>number</code>,
      description: "Number of source segments processed.",
    },
    {
      parameter: <code>sourceSegmentsDuration</code>,
      type: <code>number</code>,
      description: "Duration in seconds of session source processed.",
    },
    {
      parameter: <code>streamKey</code>,
      type: <code>string</code>,
      description:
        "Unique secret key used to form the RTMP ingest URL. All sessions with the same parentId use the same streamKey.",
    },
    {
      parameter: <code>transcodedSegments</code>,
      type: <code>number</code>,
      description:
        "Number of transcoded rendition segments processed. Should be (sourceSegments * number of profiles).",
    },
    {
      parameter: <code>transcodedSegmentsDuration</code>,
      type: <code>number</code>,
      description:
        "Duration in seconds of transcoded renditions processed. Should be (sourceSegmentsDuration * number of profiles).",
    },
    {
      parameter: <code>userId</code>,
      type: <code>string</code>,
      description:
        "Unique identifier for the Livepeer.com user account that created the parent stream object.",
    },
  ]}
/>


Livepeer.com API Reference | The session object

parameter	type	description
`createdAt`	`number`	Timestamp when the session was created. Reported in Unix epoch time.
`createdByTokenName`	`string`	Livepeer.com user-assigned name for the API key that created the stream object.
`id`	`string`	Unique identifier for the session.
`isActive`	`boolean`	`true` while the session is active and up to about five minutes after it has ended. `false` after that."
`kind`	`string`	Livepeer.com API object type.
`lastSeen`	`number`	Timestamp when video was last ingested for the session. Reported in Unix epoch time.
`name`	`string`	Additional identifier for the asset. Not customizable.
`parentId`	`string`	Points to a parent stream object. The session's parentId is the same string as its parent stream's id.
`playbackId`	`string`	Unique identifier used to form the live stream playback URL. All sessions with the same parentId have the same .m3u8 playback URL.
`profiles`	`array`	Transcoding rendition settings, inherited from the parent stream profiles. The source will be delivered with the renditions in the HLS and does not need to be redefined in the profiles parameter. If no profiles are defined, only the source will be delivered for playback.
`record`	`boolean`	true means the session is being recorded or was recorded. false means the session is not being recorded or was not recorded. IMPORTANT: If you change the parent stream record value, the new setting will only apply to future sessions, but not the active session.
`recordingStatus`	`string`	Appears only if record is true. It is either ready when the recorded live stream is available for playback or waiting while the livestream is still active or just recently completed.
`recordingURL`	`string`	Appears only if record is true and when recordingStatus changes to ready. Its value is the .m3u8 URL to stream the recorded session.
`sourceSegments`	`number`	Number of source segments processed.
`sourceSegmentsDuration`	`number`	Duration in seconds of session source processed.
`streamKey`	`string`	Unique secret key used to form the RTMP ingest URL. All sessions with the same parentId use the same streamKey.
`transcodedSegments`	`number`	Number of transcoded rendition segments processed. Should be (sourceSegments * number of profiles).
`transcodedSegmentsDuration`	`number`	Duration in seconds of transcoded renditions processed. Should be (sourceSegmentsDuration * number of profiles).
`userId`	`string`	Unique identifier for the Livepeer.com user account that created the parent stream object.