# dolphinAuthoringSession

A dolphin authoring session record carrying document, runtime, undo, selection, mode, and related state.

Last updated: 2026-09-09

Package: dolphin.authoring | Status: source-declared

Tags: authoring, class, cpu, dolphin, dolphin.authoring, method, source-example

Represent editable scenes and graph canvases, validate edits, and manage undoable transactions.

```yh
external class dolphinAuthoringSession
```

- dolphinSceneDocument document: Stores document as dolphinSceneDocument.
- dolphinSceneDocument runtime: Stores runtime as dolphinSceneDocument.
- list of dolphinSceneDocument undo: Stores undo as list of dolphinSceneDocument.
- list of int selection: Stores selection as list of int.
- int mode: Stores mode as int.
- text status: Stores status as text.
- dolphinAuthoringSession(dolphinSceneDocument document): Dolphin authoring session.
- Selected(int id) returns bool: Selected.
- Select(int id,bool additive): Select.
- Commit(dolphinSceneDocument next,text action) returns bool: Commit.
- Undo(): Undo.
- Redo(): Redo.
- Attach(int component) returns bool: Attach.
- Reference(int target) returns bool: Reference.
- Play(): Play.
- Pause(): Pause.
- Stop(): Stop.
- Step(): Step.

## Use dolphinAuthoringSession

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

Verification: type checked

```yh
using dolphin.authoring

// Represent editable scenes and graph canvases, validate edits, and manage undoable transactions.
dolphinAuthoringSession sample = dolphinAuthoringSession(dolphinSceneDocument())
Console.Log(Text.From(sample.mode))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.authoring--dolphinAuthoringSession/usage --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## dolphinAuthoringSession.Selected

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using dolphin.authoring

// Selected.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
int argument_id = 1
bool result = instance.Selected(argument_id)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.authoring--dolphinAuthoringSession/method-Selected-7 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## dolphinAuthoringSession.Select

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using dolphin.authoring

// Select.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
int argument_id = 1
bool argument_additive = true
instance.Select(argument_id, argument_additive)
Console.Log("Select completed")

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.authoring--dolphinAuthoringSession/method-Select-8 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## dolphinAuthoringSession.Commit

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using dolphin.authoring

// Commit.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
dolphinSceneDocument argument_next = dolphinSceneDocument()
text argument_action = "argument action"
bool result = instance.Commit(argument_next, argument_action)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.authoring--dolphinAuthoringSession/method-Commit-9 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## dolphinAuthoringSession.Undo

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using dolphin.authoring

// Undo.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
instance.Undo()
Console.Log("Undo completed")

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.authoring--dolphinAuthoringSession/method-Undo-10 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## dolphinAuthoringSession.Redo

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using dolphin.authoring

// Redo.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
instance.Redo()
Console.Log("Redo completed")

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.authoring--dolphinAuthoringSession/method-Redo-11 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## dolphinAuthoringSession.Attach

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using dolphin.authoring

// Attach.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
int argument_component = 1
bool result = instance.Attach(argument_component)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.authoring--dolphinAuthoringSession/method-Attach-12 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## dolphinAuthoringSession.Reference

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using dolphin.authoring

// Reference.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
int argument_target = 1
bool result = instance.Reference(argument_target)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.authoring--dolphinAuthoringSession/method-Reference-13 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## dolphinAuthoringSession.Play

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using dolphin.authoring

// Play.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
instance.Play()
Console.Log("Play completed")

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.authoring--dolphinAuthoringSession/method-Play-14 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## dolphinAuthoringSession.Pause

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using dolphin.authoring

// Pause.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
instance.Pause()
Console.Log("Pause completed")

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.authoring--dolphinAuthoringSession/method-Pause-15 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## dolphinAuthoringSession.Stop

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using dolphin.authoring

// Stop.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
instance.Stop()
Console.Log("Stop completed")

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.authoring--dolphinAuthoringSession/method-Stop-16 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## dolphinAuthoringSession.Step

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using dolphin.authoring

// Step.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
instance.Step()
Console.Log("Step completed")

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.authoring--dolphinAuthoringSession/method-Step-17 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup.

Source: dolphin/packages/authoring/src/authoring.yh

AI training permission: https://demonhunterlabs.com/ai-use