| Layer | ||||
|---|---|---|---|---|
| Properties | ||||
| Property Name | Return Data Type | Description | Example Syntax | |
| Index | Number | Returns the numerical index of this Layer Object | HippoNet.LocalHost.Engine:FindMix(1).Layers[1].Index |
|
| Path | String | Returns the full path of the Root Pin of this Layer from the Engine Root Pin | HippoNet.LocalHost.Engine:FindMix(1).Layers[1].Path |
|
| Level | Number | A value between 0.0 and 1.0 that represents the level of this Layer Object, this value can be read or set | HippoNet.LocalHost.Engine:FindMix(1).Layers[1].Level |
|
| Pause | Boolean | Returns True if the media player on this Layer Object is paused, False if it is not, this value can be read or set | HippoNet.LocalHost.Engine:FindMix(1).Layers[1].Pause |
|
| Position | Number | Returns the position of the mediaplayer playhead in milliseconds from the start of the media clip, this value can be read or set. If no media return is 1 | HippoNet.LocalHost.Engine:FindMix(1).Layers[1].Position |
|
| InPoint | Number | Returns the position of the InpoInt flag in milliseconds from the start of the media, this value can be read or set. If no media return is 1 | HippoNet.LocalHost.Engine:FindMix(1).Layers[1].InPoint |
|
| OutPoint | Number | Returns the position of the OutPoint flag in milliseconds from the start of the media, this value can be read or set. If no media return is 2147483647 | HippoNet.LocalHost.Engine:FindMix(1).Layers[1].OutPoint |
|
| PlayMode | String | Returns a string that represents the playmode of the mediaplayer from one of these values: forward forwardLoop backward backwardLoop pingPong random in out This value can be read or set |
HippoNet.LocalHost.Engine:FindMix(1).Layers[1].PlayMode |
|
| Functions | ||||
| Function Name | Parameters | Return Data Type | Description | Example Syntax |
| FadeLevel | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades the level of this layer level in the background from a value (either given or current) to the value given, over FadeTime Seconds, does not halt script execution | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FadeLevel(0, 1, 8) |
| FadeLevelWait | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades the level of this layer level from a value (either given or current) to the value given, over FadeTime Seconds, does halt script execution while in progress | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FadeLevelWait(1, 0, 15) |
| SnapEndLevel | (Number From(Optional),Number To,Number FadeTime) | Nothing | Snaps the level from a value (either given or current) to the value give after the FadeTime Seconds has passed. This does not halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:SnapEndLevel(0, 1, 10) |
| SnapEndLevelWait | (Number From(Optional),Number To,Number FadeTime) | Nothing | Snaps the level from a value (either given or current) to the value give after the FadeTime Seconds has passed. This does halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:SnapEndLevelWait(1, 0, 15) |
| EasingCubicLevel | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades level from a value (either given or current) to the value give after the FadeTime Seconds has passed using a Easing Cubic curve. This does not halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:EasingCubicLevel(0, 1, 10) |
| EasingCubicLevelWait | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades level from a value (either given or current) to the value give after the FadeTime Seconds has passed using a Easing Cubic curve. This does halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:EasingCubicLevelWait(1, 0, 15) |
| EasingSineLevel | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades level from a value (either given or current) to the value given after the FadeTime Seconds has passed using a Easing Sine curve. This does not halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:EasingSineLevel(0, 1, 10) |
| EasingSineLevelWait | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades level from a value (either given or current) to the value given after the FadeTime Seconds has passed using a Easing Sine curve. This does halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:EasingSineLevelWait(1, 0, 15) |
| EasingQuadraticLevel | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades level from a value (either given or current) to the value given after the FadeTime Seconds has passed using a Easing Quadratic curve. This does not halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:EasingQuadraticLevel(0, 1, 10) |
| EasingQuadraticLevelWait | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades level from a value (either given or current) to the value given after the FadeTime Seconds has passed using a Easing Quadratic curve. This does halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:EasingQuadraticLevelWait(1, 0, 15) |
| SetMedia | (Number MediaIndex,String PlayMode(optional),Number Position(optional),Number InPoint(optional),Number OutPoint(optional),Number MediaWait(optional)) | Nothing | Attempts to load the media with an index of into the mediaplayer and set the playmode to , InPoint to Ms, OutPoint to Ms, Playhead to Ms and then wait for Seconds before proceeding with script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:SetMedia(20, 'backward', 100, 10, 200, 300) |
| SetPreset | (Number PresetIndex) | Nothing | Attempts to load a Layer Preset with index onto this Layer Object if the preset exists | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:SetPreset(112) |
| FindPin | (String PathFromRoot) | Pin Object or Nil | Returns the Pin Object with a path of from the Root Pin of this Layer Object | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FindPin('Colour/Brightness') |
| Reset | () | Nothing | Resets the Layer Object to it’s default values | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:Reset() |
Post your comment on this topic.