# Marker

> A note pinned to a span of an item.

Symbols in this group are spelled `otio_marker_…`. An SDK drops that prefix.

## `color`

`otio_marker_color` · method · may answer nothing

Returns a marker's tint, and the name that goes with it.

`out_name` may be null if the name is not wanted. Reports `OTIO_STATUS_NO_VALUE` for an untinted marker.

```c
OtioStatus otio_marker_color(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioColor *out_color,
    OtioBuffer *out_name,
    OtioBuffer *out_error);
```

| Parameter | Type | Role |
| --- | --- | --- |
| `source` (optional) | `document` | document in |
| `node_handle` | `node` | receiver |
| `out_color` | `OtioColor` | output |
| `out_name` (optional) | `text` | output |
| `out_error` | `text` | error |

## `comment`

`otio_marker_comment` · getter

Returns a marker's note.

```c
OtioStatus otio_marker_comment(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioBuffer *out_comment,
    OtioBuffer *out_error);
```

| Parameter | Type | Role |
| --- | --- | --- |
| `source` (optional) | `document` | document in |
| `node_handle` | `node` | receiver |
| `out_comment` | `text` | output |
| `out_error` | `text` | error |

## `marked_range`

`otio_marker_marked_range` · getter

Returns the span a marker covers.

```c
OtioStatus otio_marker_marked_range(
    const OtioDocument *source,
    OtioNode node_handle,
    OtioTimeRange *out_range,
    OtioBuffer *out_error);
```

| Parameter | Type | Role |
| --- | --- | --- |
| `source` (optional) | `document` | document in |
| `node_handle` | `node` | receiver |
| `out_range` | `OtioTimeRange` | output |
| `out_error` | `text` | error |

## `new`

`otio_marker_new` · constructor

Creates a marker covering `marked_range`.

```c
OtioStatus otio_marker_new(
    OtioDocument *target,
    const char *name,
    OtioTimeRange marked_range,
    OtioNode *out_node,
    OtioBuffer *out_error);
```

| Parameter | Type | Role |
| --- | --- | --- |
| `target` | `document` | document mut |
| `name` (optional) | `text` | input |
| `marked_range` | `OtioTimeRange` | input |
| `out_node` | `node` | output |
| `out_error` | `text` | error |

## `set_color`

`otio_marker_set_color` · setter

Sets a marker's tint. `name` may be null for an unnamed colour.

```c
OtioStatus otio_marker_set_color(
    OtioDocument *target,
    OtioNode node_handle,
    OtioColor color,
    const char *name,
    OtioBuffer *out_error);
```

| Parameter | Type | Role |
| --- | --- | --- |
| `target` | `document` | document mut |
| `node_handle` | `node` | receiver |
| `color` | `OtioColor` | input |
| `name` (optional) | `text` | input |
| `out_error` | `text` | error |

## `set_comment`

`otio_marker_set_comment` · setter

Sets a marker's note.

```c
OtioStatus otio_marker_set_comment(
    OtioDocument *target,
    OtioNode node_handle,
    const char *comment,
    OtioBuffer *out_error);
```

| Parameter | Type | Role |
| --- | --- | --- |
| `target` | `document` | document mut |
| `node_handle` | `node` | receiver |
| `comment` | `text` | input |
| `out_error` | `text` | error |

## `set_marked_range`

`otio_marker_set_marked_range` · setter

Sets the span a marker covers.

```c
OtioStatus otio_marker_set_marked_range(
    OtioDocument *target,
    OtioNode node_handle,
    OtioTimeRange range,
    OtioBuffer *out_error);
```

| Parameter | Type | Role |
| --- | --- | --- |
| `target` | `document` | document mut |
| `node_handle` | `node` | receiver |
| `range` | `OtioTimeRange` | input |
| `out_error` | `text` | error |

---

Page: https://otio-rust-docs.vercel.app/reference/marker/