Clips

Exports related to clipped media.

type Aspect = 'flip' | 'maintain'

interface ClientClip 
extends Clip {
  audible: boolean
  boolean: (key: string) => boolean
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clipCachePromise: (args: InstanceCacheArgs) => Promise<DataOrError<number>>
  clipIndex: ClipIndex
  clipObject: ClipObject
  clipRects: (args: ContainerRectArgs) => RectTuple
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  container?: VisibleInstance
  content: ClippedContent
  elementPromise: (size: Size, time: Time, assureSvg: boolean) => Promise<DataOrError<SvgItemsRecord>>
  endFrame: number
  frame: number
  frames: number
  host: Plugins
  id: string
  intrinsicsKnown: (options: IntrinsicOptions) => boolean
  maxFrames: (quantize: number, trim?: number) => number
  mediaIds: Strings
  muted: boolean
  number: (key: string) => number
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  resetTiming: (instance?: Instance, quantize?: number) => void
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  sizingRect: (size: Size, loading?: boolean) => Rect
  string: (key: string) => string
  targetId: string
  timeRange: TimeRange
  toJSON: () => unknown
  track?: Track
  trackNumber: number
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweens: (key: string) => boolean
  value: (key: string) => Scalar | undefined
  visible: boolean
}

interface Clip 
extends Propertied {
  audible: boolean
  boolean: (key: string) => boolean
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clipCachePromise: (args: InstanceCacheArgs) => Promise<DataOrError<number>>
  clipIndex: ClipIndex
  clipObject: ClipObject
  clipRects: (args: ContainerRectArgs) => RectTuple
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  container?: VisibleInstance
  content: ClippedContent
  endFrame: number
  frame: number
  frames: number
  host: Plugins
  id: string
  intrinsicsKnown: (options: IntrinsicOptions) => boolean
  maxFrames: (quantize: number, trim?: number) => number
  mediaIds: Strings
  muted: boolean
  number: (key: string) => number
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  resetTiming: (instance?: Instance, quantize?: number) => void
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  sizingRect: (size: Size, loading?: boolean) => Rect
  string: (key: string) => string
  targetId: string
  timeRange: TimeRange
  toJSON: () => unknown
  track?: Track
  trackNumber: number
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweens: (key: string) => boolean
  value: (key: string) => Scalar | undefined
  visible: boolean
}

interface ClipIconArgs  {
  audible: boolean
  audibleHeight: number
  clipSize: Size
  gap?: number
  scale: number
  visible: boolean
  visibleHeight: number
  width?: number
}

interface ClipIndex 
extends ArrayOf3<number, number, number> {}

interface ClipLocation  {
  frame?: number
  index?: number
  track?: number
}

interface ClipObject 
extends WithLabelOrNot {
  container?: VisibleInstanceObject
  containerId?: string
  content?: VisibleInstanceObject | AudibleInstanceObject
  contentId?: string
  frame?: number
  frames?: number
  label?: string
  sizing?: string
  timing?: string
}

type ClippedContent = VisibleInstance | Instance

interface Instance 
extends Propertied, WithId {
  asset: Media
  assetFrames: (quantize: number) => Numbers
  assetId: string
  assetTime: (masherTime: Time) => Time
  boolean: (key: string) => boolean
  cacheInstance: (args: InstanceCacheArgs) => Promise<DataOrError<number>>
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clip: Clip
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  frames: (quantize: number) => number
  host: Plugins
  id: string
  instanceObject: InstanceObject
  intrinsicsKnown: (options: IntrinsicOptions) => boolean
  isDefault: boolean
  mediaIds: Strings
  muted: boolean
  number: (key: string) => number
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  scalarsById: (targetId: string, time?: Time, timeIsStart?: boolean, useNames?: boolean) => SignalScalarRecord
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  string: (key: string) => string
  targetId: string
  toJSON: () => unknown
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweens: (key: string) => boolean
  value: (key: string) => Scalar | undefined
}

interface InstanceArgs 
extends InstanceObject {
  asset: Media
}

interface InstanceObject  {}

type Sizing = 'mash' | 'content' | 'container'

type Timing = 'custom' | 'content' | 'container'

type Transparency = 'alpha' | 'luminance'

interface TrimClickInfo  {
  clickedScroll: number
  clickedValue: number
  clickedX: number
  key: string
}

interface Tweening  {
  color?: boolean
  point?: boolean
  size?: boolean
}

/** @implements ClientClip */
class ClientClipClass
extends ClipClass {
  _track: Track | undefined
  audible: boolean
  boolean: (key: string) => boolean
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clipCachePromise: (args: InstanceCacheArgs) => Promise<DataOrError<number>>
  clipIndex: ClipIndex
  clipObject: ClipObject
  clipRects: (args: ContainerRectArgs) => RectTuple
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  container?: VisibleInstance
  content: ClippedContent
  elementPromise: (size: Size, time: Time, assureSvg: boolean) => Promise<DataOrError<SvgItemsRecord>>
  endFrame: number
  endTime: (quantize: number) => Time
  frame: number
  frames: number
  host: Plugins
  id: string
  intrinsicsKnown: (options: IntrinsicOptions) => boolean
  maxFrames: (quantize: number, trim?: number) => number
  mediaIds: Strings
  muted: boolean
  number: (key: string) => number
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  resetTiming: (instance?: Instance, quantize?: number) => void
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  sizingRect: (size: Size, loading?: boolean) => Rect
  string: (key: string) => string
  targetId: string
  timeRange: TimeRange
  timingFrames: (quantize?: number, timing?: Timing) => number
  toJSON: () => unknown
  track?: Track
  trackNumber: number
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweens: (key: string) => boolean
  tweensProperty: (key: string) => boolean
  validSizings: () => Array<Sizing>
  validTimings: () => Array<Timing>
  value: (key: string) => Scalar | undefined
  visible: boolean
}

/** @implements Clip */
class ClipClass
extends PropertiedClass {
  _track: Track | undefined
  audible: boolean
  boolean: (key: string) => boolean
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clipCachePromise: (args: InstanceCacheArgs) => Promise<DataOrError<number>>
  clipIndex: ClipIndex
  clipObject: ClipObject
  clipRects: (args: ContainerRectArgs) => RectTuple
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  container?: VisibleInstance
  content: ClippedContent
  endFrame: number
  endTime: (quantize: number) => Time
  frame: number
  frames: number
  host: Plugins
  id: string
  intrinsicsKnown: (options: IntrinsicOptions) => boolean
  maxFrames: (quantize: number, trim?: number) => number
  mediaIds: Strings
  muted: boolean
  number: (key: string) => number
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  resetTiming: (instance?: Instance, quantize?: number) => void
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  sizingRect: (size: Size, loading?: boolean) => Rect
  string: (key: string) => string
  targetId: string
  timeRange: TimeRange
  timingFrames: (quantize?: number, timing?: Timing) => number
  toJSON: () => unknown
  track?: Track
  trackNumber: number
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweens: (key: string) => boolean
  tweensProperty: (key: string) => boolean
  validSizings: () => Array<Sizing>
  validTimings: () => Array<Timing>
  value: (key: string) => Scalar | undefined
  visible: boolean
}

/** @implements Instance */
class InstanceClass
extends PropertiedClass {
  asset: Media
  assetFrames: (quantize: number) => Numbers
  assetId: string
  assetTime: (masherTime: Time) => Time
  boolean: (key: string) => boolean
  cacheInstance: (args: InstanceCacheArgs) => Promise<DataOrError<number>>
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clip: Clip
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  frames: (quantize: number) => number
  hasIntrinsicTiming: boolean
  host: Plugins
  id: string
  instanceObject: InstanceObject
  intrinsicsKnown: (options: IntrinsicOptions) => boolean
  isDefault: boolean
  mediaIds: Strings
  muted: boolean
  number: (key: string) => number
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  scalarsById: (targetId: string, time?: Time, timeIsStart?: boolean, useNames?: boolean) => SignalScalarRecord
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  string: (key: string) => string
  targetId: string
  toJSON: () => unknown
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweens: (key: string) => boolean
  tweensProperty: (key: string) => boolean
  value: (key: string) => Scalar | undefined
}

/** Type assertion for Aspect */
function assertAspect(
  value: Any, 
  name?: string
): void

/** Type assertion for VisibleInstance */
function assertCanBeContainerInstance(
  value?: unknown, 
  name?: string
): void

/** Type assertion for ClippedContent */
function assertCanBeContentInstance(
  value?: unknown, 
  name?: string
): void

/** Type assertion for ClientClip */
function assertClientClip(
  value: unknown, 
  name?: string
): void

/** Type assertion for Clip */
function assertClip(
  value: unknown, 
  name?: string
): void

/** Type assertion for Instance */
function assertInstance(
  value: unknown, 
  name?: string
): void

/** Type assertion for Timing */
function assertTiming(
  value: Any, 
  name?: string
): void

/** Type assertion for Transparency */
function assertTransparency(
  value: Any, 
  name?: string
): void

/** Type guard for VisibleInstance */
function canBeContainerInstance(
  value?: unknown
): boolean

/** Type guard for ClippedContent */
function canBeContentInstance(
  value?: unknown
): boolean

/** Type guard for Aspect */
function isAspect(
  value: Any
): boolean

/** Type guard for ClientClip */
function isClientClip(
  value: unknown
): boolean

/** Type guard for Instance */
function isClientInstance(
  value: unknown
): boolean

/** Type guard for Clip */
function isClip(
  value: unknown
): boolean

/** Type guard for Instance */
function isInstance(
  value?: unknown
): boolean

/** Type guard for Timing */
function isTiming(
  value: Any
): boolean

/** Type guard for Transparency */
function isTransparency(
  value: Any
): boolean

function propertyInstance(
  arg: string | PropertyObject, 
  owner?: string, 
  typeDefault?: string
): Property