JUCE: ARAHostModel::PlaybackRegion Struct Reference

JUCE

Public Member Functions | Static Public Member Functions | List of all members
ARAHostModel::PlaybackRegion Struct Reference
juce_audio_processors » format_types

Helper class for the host side implementation of the ARA PlaybackRegion model object. More...

`#include <juce_ARAHosting.h>`

## Public Member Functions
| PlaybackRegion (ARA::ARAPlaybackRegionHostRef hostRef, ARA::Host::DocumentController &dc, AudioModification &m, const ARA::ARAPlaybackRegionProperties &props)
| ~PlaybackRegion ()
void | update (const ARA::ARAPlaybackRegionProperties &props)
| Updates the state of the corresponding ARA model object. More...
void | addListener (DeletionListener &x)
| Adds a DeletionListener object that will be notified when the PlaybackRegion object is deleted. More...
auto & | getAudioModification () const
| Returns the AudioModification containing this PlaybackRegion. More...
ARA::ARAPlaybackRegionRef | getPluginRef () const noexcept
| Returns the plugin side reference to the PlaybackRegion. More...
DeletionListener & | getDeletionListener () const noexcept

## Static Public Member Functions
static constexpr auto | getEmptyProperties ()
| Returns an ARA versioned struct with the `structSize` correctly set for the currently used SDK version. More...

## Detailed Description

Helper class for the host side implementation of the ARA PlaybackRegion model object.

Its intended use is to add a member variable of this type to your host side PlaybackRegion implementation. Then it provides a RAII approach to managing the lifetime of the corresponding objects created inside the DocumentController. When the host side object is instantiated an ARA model object is also created in the DocumentController. When the host side object is deleted it will be removed from the DocumentController as well.

The class will automatically put the DocumentController into editable state for operations that mandate this e.g. creation, deletion or updating.

You can encapsulate multiple such operations into a scope with an ARAEditGuard in order to invoke the editable state of the DocumentController only once.

## Constructor & Destructor Documentation

## ◆ PlaybackRegion()

ARAHostModel::PlaybackRegion::PlaybackRegion | ( | ARA::ARAPlaybackRegionHostRef | hostRef,
|  | ARA::Host::DocumentController & | dc,
|  | AudioModification & | m,
|  | const ARA::ARAPlaybackRegionProperties & | props
| ) |  |

## ◆ ~PlaybackRegion()

ARAHostModel::PlaybackRegion::~PlaybackRegion | ( |  | ) |

## Member Function Documentation

## ◆ getEmptyProperties()

static constexpr auto ARAHostModel::PlaybackRegion::getEmptyProperties | ( |  | ) |
| staticconstexpr

Returns an ARA versioned struct with the `structSize` correctly set for the currently used SDK version.

You should leave `structSize` unchanged, and fill out the rest of the fields appropriately for the host implementation of the ARA model object.

References gl::color, and makeARASizedStruct().

## ◆ update()

void ARAHostModel::PlaybackRegion::update | ( | const ARA::ARAPlaybackRegionProperties & | props | ) |

Updates the state of the corresponding ARA model object.

Places the DocumentController in editable state.

You can use getEmptyProperties() to acquire a properties struct where the `structSize` field has already been correctly set.

## ◆ addListener()

void ARAHostModel::PlaybackRegion::addListener | ( | DeletionListener & | x | ) |

Adds a DeletionListener object that will be notified when the PlaybackRegion object is deleted.

Used by the PlaybackRegionRegistry.

See also
  PlaybackRendererInterface, EditorRendererInterface

## ◆ getAudioModification()

auto & ARAHostModel::PlaybackRegion::getAudioModification | ( |  | ) | const

Returns the AudioModification containing this PlaybackRegion.

## ◆ getPluginRef()

ARA::ARAPlaybackRegionRef ARAHostModel::PlaybackRegion::getPluginRef | ( |  | ) | const
| noexcept

Returns the plugin side reference to the PlaybackRegion.

## ◆ getDeletionListener()

DeletionListener & ARAHostModel::PlaybackRegion::getDeletionListener | ( |  | ) | const
| noexcept

The documentation for this struct was generated from the following file:

- juce_ARAHosting.h