<!-- # hard line break macro for HTML -->

# fiftyone.core.frame_utils

Frame utilities.

Copyright 2017-2026, Voxel51, Inc.
<br/>
[voxel51.com](https://voxel51.com/)
<br/>
<br/>

**Functions:**

| [`is_frame_number`](#fiftyone.core.frame_utils.is_frame_number)(value)             | Determines whether the provided value is a frame number.   |
|------------------------------------------------------------------------------------|------------------------------------------------------------|
| [`validate_frame_number`](#fiftyone.core.frame_utils.validate_frame_number)(value) | Validates that the provided value is a frame number.       |

**Exceptions:**

| [`FrameError`](#fiftyone.core.frame_utils.FrameError)   | Exception raised when an invalid frame number is encountered.   |
|---------------------------------------------------------|-----------------------------------------------------------------|

### fiftyone.core.frame_utils.is_frame_number(value)

Determines whether the provided value is a frame number.

Frame numbers are strictly positive integers.

* **Parameters:**
  **value** – a value
* **Returns:**
  True/False
* **Raises:**
  [**FrameError**](#fiftyone.core.frame_utils.FrameError) – if `value` is an integer but is not strictly
      positive

### fiftyone.core.frame_utils.validate_frame_number(value)

Validates that the provided value is a frame number.

Frame numbers are strictly positive integers.

* **Parameters:**
  **value** – a value
* **Raises:**
  [**FrameError**](#fiftyone.core.frame_utils.FrameError) – if `value` is not a frame number

### *exception* fiftyone.core.frame_utils.FrameError

Bases: `ValueError`

Exception raised when an invalid frame number is encountered.

**Methods:**

| [`add_note`](#fiftyone.core.frame_utils.FrameError.add_note)(object, /)             | Exception.add_note(note) -- add a note to the exception                         |
|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
| [`with_traceback`](#fiftyone.core.frame_utils.FrameError.with_traceback)(object, /) | Exception.with_traceback(tb) -- set self._\_traceback_\_ to tb and return self. |

**Attributes:**

| [`args`](#fiftyone.core.frame_utils.FrameError.args)   |    |
|--------------------------------------------------------|----|

#### add_note(object,)

Exception.add_note(note) –
add a note to the exception

#### args

#### with_traceback(object,)

Exception.with_traceback(tb) –
set self._\_traceback_\_ to tb and return self.