> ## Documentation Index
> Fetch the complete documentation index at: https://docs.encord.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Beta.scene.stream

Stream builder classes for constructing scene streams.

Each stream type has a dedicated builder returned by the corresponding
`add_*_stream` method on [SceneBuilder](/sdk-documentation/sdk-references/beta.scene.builder.md#scenebuilder-objects).

## \_StreamBuilderBase Objects

```python theme={"dark"}
class _StreamBuilderBase()
```

Internal base -- not part of the public API.

#### name

```python theme={"dark"}
@property
def name() -> str
```

The stream name used to register this stream in the [SceneBuilder](/sdk-documentation/sdk-references/beta.scene.builder.md#scenebuilder-objects).

## TimeSeriesStreamBuilder Objects

```python theme={"dark"}
class TimeSeriesStreamBuilder(_StreamBuilderBase)
```

Builder for a self-contained CSV time-series stream.

Returned by [add\_time\_series\_stream()](/sdk-documentation/sdk-references/beta.scene.builder.md#add_time_series_stream).

## PCDStreamBuilder Objects

```python theme={"dark"}
class PCDStreamBuilder(_StreamBuilderBase)
```

Builder for a point-cloud stream.

Returned by [add\_pcd\_stream()](/sdk-documentation/sdk-references/beta.scene.builder.md#add_pcd_stream).

#### add\_pcd

```python theme={"dark"}
def add_pcd(*, uri: str, timestamp: float) -> PCDStreamBuilder
```

Append a single point-cloud event.

**Arguments**:

* `uri` - Non-empty URI pointing to the point-cloud file.
* `timestamp` - Scene timestamp for this event.

#### set\_frame\_of\_reference

```python theme={"dark"}
def set_frame_of_reference(for_id: str | FoRStreamBuilder) -> PCDStreamBuilder
```

Link this stream to a frame-of-reference stream.

**Arguments**:

* `for_id` - The **stream name** of a FoR stream, or a
  [FoRStreamBuilder](/sdk-documentation/sdk-references/beta.scene.stream.md#forstreambuilder-objects) instance.

#### set\_pose

```python theme={"dark"}
def set_pose(pose: Pose) -> PCDStreamBuilder
```

Set a static pose for this stream.

## CameraStreamBuilder Objects

```python theme={"dark"}
class CameraStreamBuilder(_StreamBuilderBase)
```

Builder for a camera-parameters stream.

Returned by [add\_camera\_stream()](/sdk-documentation/sdk-references/beta.scene.builder.md#add_camera_stream).

#### add\_camera\_params

```python theme={"dark"}
def add_camera_params(width: int, height: int, intrinsics: Intrinsics, *,
                      timestamp: float) -> CameraStreamBuilder
```

Append a camera-parameters event.

**Arguments**:

* `width` - Image width in pixels (must be >= 0).
* `height` - Image height in pixels (must be >= 0).
* `intrinsics` - Camera intrinsics ([SimpleIntrinsics](/sdk-documentation/sdk-references/beta.scene.intrinsics.md#simpleintrinsics-objects) or
  [AdvancedIntrinsics](/sdk-documentation/sdk-references/beta.scene.intrinsics.md#advancedintrinsics-objects)).
* `timestamp` - Scene timestamp for this event.

#### set\_frame\_of\_reference

```python theme={"dark"}
def set_frame_of_reference(
        for_id: str | FoRStreamBuilder) -> CameraStreamBuilder
```

Link this stream to a frame-of-reference stream.

**Arguments**:

* `for_id` - The **stream name** of a FoR stream, or a
  [FoRStreamBuilder](/sdk-documentation/sdk-references/beta.scene.stream.md#forstreambuilder-objects) instance.

#### set\_pose

```python theme={"dark"}
def set_pose(pose: Pose) -> CameraStreamBuilder
```

Set a static pose for this stream.

## FoRStreamBuilder Objects

```python theme={"dark"}
class FoRStreamBuilder(_StreamBuilderBase)
```

Builder for a frame-of-reference (FoR) stream.

Returned by [add\_for\_stream()](/sdk-documentation/sdk-references/beta.scene.builder.md#add_for_stream).

#### add\_pose

```python theme={"dark"}
def add_pose(pose: Pose, *, timestamp: float) -> FoRStreamBuilder
```

Append a frame-of-reference event.

**Arguments**:

* `pose` - The pose for this event (any supported rotation
  encoding).
* `timestamp` - Scene timestamp for this event.

## ImageStreamBuilder Objects

```python theme={"dark"}
class ImageStreamBuilder(_StreamBuilderBase)
```

Builder for an image stream linked to a camera.

Returned by [add\_image\_stream()](/sdk-documentation/sdk-references/beta.scene.builder.md#add_image_stream).

#### add\_image

```python theme={"dark"}
def add_image(*, uri: str, timestamp: float) -> ImageStreamBuilder
```

Append an image event.

**Arguments**:

* `uri` - Non-empty URI pointing to the image file.
* `timestamp` - Scene timestamp for this event.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.