SVGA Format

https://github.com/svga/svga-format
Admin
SVGA Format is an animation format specification, similar to Dragonbones/CreateJS, that describes...
Tokens:211,703
Snippets:1,403
Trust Score:8.8
Update:2 days ago
Show doc for...
Tokens:
Raw
### FrameEntity.getLayout / setLayout

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Gets or sets the layout of a frame entity. Returns undefined until set.

```APIDOC
## FrameEntity.getLayout / setLayout

### Description
Gets or sets the layout of a frame entity. Returns undefined until set.

### Method
- `getLayout()` - Returns `proto.com.opensource.svga.Layout|undefined`
- `setLayout(value)` - Sets the layout value.

### Parameters
- `value` (proto.com.opensource.svga.Layout) - Required - The layout to set.

### Returns
- `getLayout()` returns `proto.com.opensource.svga.Layout|undefined`
- `setLayout()` returns void
```

--------------------------------

### Wire 220 message class shape (MovieParams example)

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-wire.md

Shows the immutable value-object shape generated by Square Wire compiler 2.2.0 for each top-level message. Includes a static ProtoAdapter, DEFAULT_* constants, public final fields, constructors, newBuilder(), value-semantics overrides, and a fluent Builder with one setter per field. Setters are named after the proto field name (camelCase as-is, e.g. viewBoxWidth(Float) not setViewBoxWidth).

```java
public final class MovieParams extends Message<MovieParams, MovieParams.Builder> {
  public static final ProtoAdapter<MovieParams> ADAPTER = new ProtoAdapter_MovieParams();

  public static final Float DEFAULT_VIEWBOXWIDTH = 0.0f;
  public static final Float DEFAULT_VIEWBOXHEIGHT = 0.0f;
  public static final Integer DEFAULT_FPS = 0;
  public static final Integer DEFAULT_FRAMES = 0;

  public final Float viewBoxWidth;
  public final Float viewBoxHeight;
  public final Integer fps;
  public final Integer frames;

  public MovieParams(Float viewBoxWidth, Float viewBoxHeight, Integer fps, Integer frames) { ... }
  public MovieParams(Float viewBoxWidth, Float viewBoxHeight, Integer fps, Integer frames, ByteString unknownFields) { ... }

  public Builder newBuilder() { ... }
  public boolean equals(Object other) { ... }
  public int hashCode() { ... }
  public String toString() { ... }

  public static final class Builder extends Message.Builder<MovieParams, Builder> {
    public Float viewBoxWidth;
    public Float viewBoxHeight;
    public Integer fps;
    public Integer frames;
    public Builder() { ... }
    public Builder viewBoxWidth(Float viewBoxWidth) { this.viewBoxWidth = viewBoxWidth; return this; }
    // ... one fluent setter per field ...
    public MovieParams build() { ... }
  }
  private static final class ProtoAdapter_MovieParams extends ProtoAdapter<MovieParams> { ... }
}
```

--------------------------------

### MovieEntity.getImagesMap / clearImagesMap

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Gets or clears the map of images associated with the movie entity.

```APIDOC
## MovieEntity.getImagesMap / clearImagesMap

### Description
Gets or clears the map of images associated with the movie entity.

### Methods
- `getImagesMap(opt_noLazyCreate)` - Returns the map of images.
- `clearImagesMap()` - Clears the map.

### Parameters
- `opt_noLazyCreate` (boolean) - Optional - If true, does not lazily create the map.

### Returns
- `getImagesMap()` returns `jspb.Map<string, string|Uint8Array>`.
- `clearImagesMap()` returns void.
```

--------------------------------

### Deserialize a decompressed .svga payload

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Use this snippet to read a .svga file, decompress it with zlib, and parse it into a MovieEntity. The example logs the version, FPS, and retrieves PNG image data from the images map.

```javascript
const fs = require('fs');
const svga = require('./svga_pb');
const zlib = require('zlib');

const buffer = zlib.inflateSync(fs.readFileSync('awesome.svga'));
const movie = svga.MovieEntity.deserializeBinary(buffer);

console.log(movie.getVersion());                       // "2.0.0"
console.log(movie.getParams().getFps());               // 20
const folder = movie.getImagesMap().get('awesome');    // Uint8Array PNG data
```

--------------------------------

### Building a movie with builder

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-protoc.md

Constructs a MovieEntity with version, params, images, and sprites, then serializes to bytes.

```java
MovieEntity movie = MovieEntity.newBuilder()
    .setVersion("2.0.0")
    .setParams(MovieParams.newBuilder()
        .setViewBoxWidth(300f)
        .setViewBoxHeight(300f)
        .setFps(20)
        .setFrames(144))
    .putImages("AwesomeSprite", ByteString.copyFrom(pngBytes))
    .addSprites(SpriteEntity.newBuilder()
        .setImageKey("AwesomeSprite")
        .addFrames(FrameEntity.newBuilder()
            .setAlpha(1.0f)
            .setTransform(Transform.newBuilder().setA(1.0f).setD(1.0f))))
    .build();

byte[] svgaFileBytes = deflateZlib(movie.toByteArray());
```

--------------------------------

### Build and encode SVGA MovieEntity with Builder

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-wire.md

Constructs a MovieEntity using generated builders and encodes it to wire bytes with ADAPTER.encode, then zlib-deflates the result. Requires the same proto classes and okio ByteString.

```java
MovieEntity movie = new MovieEntity.Builder()
    .version("2.0.0")
    .params(new MovieParams.Builder()
        .viewBoxWidth(300f).viewBoxHeight(300f).fps(20).frames(144)
        .build())
    .images(singletonMap("AwesomeSprite", ByteString.of(pngBytes)))
    .sprites(singletonList(new SpriteEntity.Builder()
        .imageKey("AwesomeSprite")
        .frames(singletonList(new FrameEntity.Builder()
            .alpha(1.0f)
            .transform(new Transform.Builder().a(1.0f).d(1.0f).build())
            .build()))
        .build()))
    .build();

byte[] fileBytes = zlibDeflate(movie.ADAPTER.encode(movie).toByteArray());
```

--------------------------------

### create()

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/dart.md

Static factory method that creates a new empty MovieParams instance.

```APIDOC
## create()

### Description
Same as the `MovieParams()` factory.

### Method
static

### Signature
`static MovieParams create()`

### Returns
- **MovieParams** - A new empty message instance.
```

--------------------------------

### ShapeType enum

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-protoc.md

Enum representing shape types. Provides constants SHAPE, RECT, ELLIPSE, KEEP, and UNRECOGNIZED, with methods to convert from number and get the numeric value.

```APIDOC
## ShapeType enum

### Description
Enum representing shape types. Provides constants SHAPE, RECT, ELLIPSE, KEEP, and UNRECOGNIZED, with methods to convert from number and get the numeric value.

### Constants
- **SHAPE(0)**
- **RECT(1)**
- **ELLIPSE(2)**
- **KEEP(3)**
- **UNRECOGNIZED(-1)**

### Methods
- **forNumber(int value)** - Returns the ShapeType for the given number
- **getNumber()** - Returns the numeric value of the enum constant
- **getValueDescriptor()** - Returns the value descriptor
- **getDescriptorForType()** - Returns the enum descriptor
- **getEnumDescriptor()** - Returns the enum descriptor
```

--------------------------------

### Objective-C compile-time switch for protobuf imports

Source: https://github.com/svga/svga-format/blob/master/_autodocs/configuration.md

Controls whether to use framework-style imports for Protobuf. Defaults to 0, using local header imports; set to 1 for CocoaPods framework style.

```objc
#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
 #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
#endif
```

--------------------------------

### SpriteEntity.Builder methods

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-protoc.md

Builder methods for constructing SpriteEntity. Includes setImageKey and addFrames.

```APIDOC
## SpriteEntity.Builder methods

### Description
Builder methods for constructing SpriteEntity. Includes setImageKey and addFrames.

### Methods
- **setImageKey(String)** - Sets the image key
- **addFrames(FrameEntity)** - Adds a frame entity
```

--------------------------------

### MovieEntity.Builder methods

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-protoc.md

Builder methods for constructing a MovieEntity. Includes setVersion, setParams, putImages, addSprites, and build.

```APIDOC
## MovieEntity.Builder methods

### Description
Builder methods for constructing a MovieEntity. Includes setVersion, setParams, putImages, addSprites, and build.

### Methods
- **setVersion(String)** - Sets the version string
- **setParams(MovieParams)** - Sets the movie parameters
- **putImages(String, ByteString)** - Adds an image with a key and byte string
- **addSprites(SpriteEntity)** - Adds a sprite entity
- **build()** - Builds the MovieEntity
```

--------------------------------

### Layout message definition

Source: https://github.com/svga/svga-format/blob/master/_autodocs/types.md

Defines the initial constraint rectangle for a layer using four float fields (origin x,y and size width×height). All fields are optional (no required fields).

```proto
message Layout {
    float x = 1;
    float y = 2;
    float width = 3;
    float height = 4;
}
```

--------------------------------

### toObject(opt_includeInstance)

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Returns a plain JavaScript object representation of the message, suitable for JSON serialization or Soy templates.

```APIDOC
## toObject(opt_includeInstance)

### Description
Returns a plain JavaScript object representation of the message, suitable for JSON serialization or Soy templates.

### Method
`proto.com.opensource.svga.MovieParams.prototype.toObject = function(opt_includeInstance)`

### Parameters
- `opt_includeInstance` (boolean) - Optional - Whether to include the instance itself in the object.

### Returns
- plain `Object` - The plain-JS object representation.

### Request Example
```js
const obj = message.toObject();
```
```

--------------------------------

### FrameEntity.Builder methods

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-protoc.md

Builder methods for constructing FrameEntity. Includes setAlpha and setTransform.

```APIDOC
## FrameEntity.Builder methods

### Description
Builder methods for constructing FrameEntity. Includes setAlpha and setTransform.

### Methods
- **setAlpha(float)** - Sets the alpha value
- **setTransform(Transform)** - Sets the transform
```

--------------------------------

### MovieParams.Builder methods

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-protoc.md

Builder methods for constructing MovieParams. Includes setViewBoxWidth, setViewBoxHeight, setFps, setFrames.

```APIDOC
## MovieParams.Builder methods

### Description
Builder methods for constructing MovieParams. Includes setViewBoxWidth, setViewBoxHeight, setFps, setFrames.

### Methods
- **setViewBoxWidth(float)** - Sets the view box width
- **setViewBoxHeight(float)** - Sets the view box height
- **setFps(int)** - Sets the frames per second
- **setFrames(int)** - Sets the total number of frames
```

--------------------------------

### AudioEntity

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-wire.md

Immutable value object representing the audio entity message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

```APIDOC
## AudioEntity

### Description
Immutable value object representing the audio entity message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

### Constructor
- `AudioEntity(...)` - Canonical public constructor in field-tag order.
- `AudioEntity(..., ByteString unknownFields)` - Constructor with unknown-field preservation.

### Fields
- `audioKey` - Immutable field value.
- `startFrame` - Immutable field value.
- `endFrame` - Immutable field value.
- `startTime` - Immutable field value.
- `totalTime` - Immutable field value.

### Methods
- `newBuilder()` - Returns a Builder pre-populated from this instance.
- `equals(Object other)` - Value equality.
- `hashCode()` - Hash code.
- `toString()` - Prints tag-numbered `field = value` lines.

### Builder
- `Builder()` - Default constructor.
- `audioKey(...)` - Fluent setter, returns the builder.
- `startFrame(...)` - Fluent setter, returns the builder.
- `endFrame(...)` - Fluent setter, returns the builder.
- `startTime(...)` - Fluent setter, returns the builder.
- `totalTime(...)` - Fluent setter, returns the builder.
- `build()` - Constructs an AudioEntity instance.

### Static Members
- `ADAPTER` (ProtoAdapter<AudioEntity>) - Wire codec for the message.
```

--------------------------------

### Build and serialize a movie

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Use this snippet to construct a MovieEntity with parameters, sprites, frames, and shapes, then serialize and compress it to a .svga file. Note the lower-cased field names for viewbox dimensions and the oneof case for shape.

```javascript
const svga = require('./svga_pb');

const movie = new svga.MovieEntity();
movie.setVersion('2.0.0');

const params = new svga.MovieParams();
params.setViewboxwidth(300);   // note: lower-cased field name
params.setViewboxheight(300);
params.setFps(20);
params.setFrames(144);
movie.setParams(params);

const sprite = new svga.SpriteEntity();
sprite.setImagekey('awesome');
const frame = new svga.FrameEntity();
frame.setAlpha(1.0);
const shape = new svga.ShapeEntity();
shape.setType(svga.ShapeEntity.ShapeType.SHAPE);
const args = new svga.ShapeEntity.ShapeArgs();
args.setD('M 0 0 L 100 100');
shape.setShape(args);           // sets oneof case SHAPE
frame.addShapes(shape);
sprite.addFrames(frame);
movie.addSprites(sprite);

const payload = zlib.deflateSync(movie.serializeBinary()); // write to .svga
```

--------------------------------

### Transform.Builder methods

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-protoc.md

Builder methods for constructing Transform. Includes setA and setD.

```APIDOC
## Transform.Builder methods

### Description
Builder methods for constructing Transform. Includes setA and setD.

### Methods
- **setA(float)** - Sets the 'a' value
- **setD(float)** - Sets the 'd' value
```

--------------------------------

### Layout

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-wire.md

Immutable value object representing the layout message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

```APIDOC
## Layout

### Description
Immutable value object representing the layout message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

### Constructor
- `Layout(...)` - Canonical public constructor in field-tag order.
- `Layout(..., ByteString unknownFields)` - Constructor with unknown-field preservation.

### Fields
- `x` - Immutable field value.
- `y` - Immutable field value.
- `width` - Immutable field value.
- `height` - Immutable field value.

### Methods
- `newBuilder()` - Returns a Builder pre-populated from this instance.
- `equals(Object other)` - Value equality.
- `hashCode()` - Hash code.
- `toString()` - Prints tag-numbered `field = value` lines.

### Builder
- `Builder()` - Default constructor.
- `x(...)` - Fluent setter, returns the builder.
- `y(...)` - Fluent setter, returns the builder.
- `width(...)` - Fluent setter, returns the builder.
- `height(...)` - Fluent setter, returns the builder.
- `build()` - Constructs a Layout instance.

### Static Members
- `ADAPTER` (ProtoAdapter<Layout>) - Wire codec for the message.
```

--------------------------------

### Code generation commands in svga.pb.sh

Source: https://github.com/svga/svga-format/blob/master/_autodocs/configuration.md

Regenerates all language bindings from svga.proto using protoc and pbjs. Produces Objective-C, Java, JavaScript, JSON, and Wire-format outputs.

```sh
protoc --objc_out="./" svga.proto
protoc --java_out="./" svga.proto
protoc --js_out=import_style=commonjs,binary:. svga.proto
pbjs -t json svga.proto > svga.json
java -jar wire-compiler-2.2.0-jar-with-dependencies.jar --proto_path=./ --java_out=wire220 svga.proto
```

--------------------------------

### registerAllExtensions

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-protoc.md

Registers file-level extensions for the SVGA protobuf schema. Since no extensions are declared in svga.proto, these are no-ops but are generated for consistency.

```APIDOC
## registerAllExtensions

### Description
Registers file-level extensions for the SVGA protobuf schema. Since no extensions are declared in svga.proto, these are no-ops but are generated for consistency.

### Method
static void

### Parameters
- `registry` (ExtensionRegistryLite) - Required - The extension registry to register with.
- `registry` (ExtensionRegistry) - Required - The extension registry to register with.

### Return Value
void
```

--------------------------------

### ShapeEntity.ShapeStyle.LineJoin

Source: https://github.com/svga/svga-format/blob/master/_autodocs/types.md

Enumeration of line join styles. Accepted/returned by `ShapeEntity.ShapeStyle.lineJoin`.

```APIDOC
## ShapeEntity.ShapeStyle.LineJoin

### Description
Enumeration of line join styles. Accepted/returned by `ShapeEntity.ShapeStyle.lineJoin`.

### Constants
- `LineJoin_MITER` (0)
- `LineJoin_ROUND` (1)
- `LineJoin_BEVEL` (2)

### Usage
- JS enum object keys: `LINEJOIN_MITER/LINEJOIN_ROUND/LINEJOIN_BEVEL`
```

--------------------------------

### Proto file options in svga.proto

Source: https://github.com/svga/svga-format/blob/master/_autodocs/configuration.md

Defines the protobuf schema for SVGA format with proto3 syntax, package, and language-specific options. Sets Objective-C class prefix and Java package for generated bindings.

```proto
syntax = "proto3";
package com.opensource.svga;
option objc_class_prefix = "SVGAProto";
option java_package = "com.opensource.svgaplayer.proto";
```

--------------------------------

### info_

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/dart.md

Provides builder metadata used for serialization and JSON codecs.

```APIDOC
## info_

### Description
Builder metadata for `writeToBuffer`/JSON codecs.

### Method
property

### Signature
`$pb.BuilderInfo get info_`

### Returns
- **$pb.BuilderInfo** - The builder metadata.
```

--------------------------------

### SVGAProtoSvgaRoot root object

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/objective-c.md

Root object for the generated Objective-C bindings. Inherits +extensionRegistry from GPBRootObject; no extensions are defined in this file.

```Objective-C
@interface SVGAProtoSvgaRoot : GPBRootObject
@end
```

--------------------------------

### MovieEntity.fromBuffer/fromJson (Dart)

Source: https://github.com/svga/svga-format/blob/master/_autodocs/types.md

Constructs a MovieEntity from a buffer or JSON in Dart. Returns a MovieEntity instance.

```APIDOC
## MovieEntity.fromBuffer/fromJson (Dart)

### Description
Constructs a MovieEntity from a buffer or JSON in Dart. Returns a MovieEntity instance.

### Method
fromBuffer / fromJson

### Parameters
- **buffer** (Buffer) - Required - The binary buffer to parse.
- **json** (String) - Required - The JSON string to parse.

### Returns
- **MovieEntity** - The parsed MovieEntity object.
```

--------------------------------

### ShapeEntity.ShapeStyle.LineCap

Source: https://github.com/svga/svga-format/blob/master/_autodocs/types.md

Enumeration of line cap styles. Accepted/returned by `ShapeEntity.ShapeStyle.lineCap`.

```APIDOC
## ShapeEntity.ShapeStyle.LineCap

### Description
Enumeration of line cap styles. Accepted/returned by `ShapeEntity.ShapeStyle.lineCap`.

### Constants
- `LineCap_BUTT` (0)
- `LineCap_ROUND` (1)
- `LineCap_SQUARE` (2)

### Usage
- JS enum object keys are uppercased: `LINECAP_BUTT/LINECAP_ROUND/LINECAP_SQUARE`
```

--------------------------------

### MovieParams.fromBuffer(i, [r = ExtensionRegistry.EMPTY])

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/dart.md

Factory constructor that parses a binary protobuf payload from a list of bytes. Unknown extensions are resolved using the provided extension registry.

```APIDOC
## MovieParams.fromBuffer(i, [r = ExtensionRegistry.EMPTY])

### Description
Parses a binary protobuf payload (`List<int>` of bytes); unknown extensions resolved via `r`.

### Method
factory

### Signature
`MovieParams.fromBuffer($core.List<$core.int> i, [$pb.ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])`

### Parameters
- **i** (`List<int>`) - Required - The binary protobuf payload.
- **r** (`ExtensionRegistry`) - Optional - Extension registry for resolving unknown extensions. Defaults to `ExtensionRegistry.EMPTY`.

### Returns
- **MovieParams** - A new message instance parsed from the buffer.
```

--------------------------------

### Decode SVGA wire data with MovieEntity.ADAPTER.decode

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-wire.md

Decodes zlib-inflated wire bytes into a MovieEntity using the generated ProtoAdapter. Prints version, fps, sprite image keys, and shape path data. Requires the svgaplayer proto classes and okio ByteString.

```java
import com.opensource.svgaplayer.proto.*;
import okio.ByteString;

ByteString wireData = ByteString.of(zlibInflatedBytes);
MovieEntity movie = MovieEntity.ADAPTER.decode(wireData);

System.out.println(movie.version);                 // "2.0.0"
System.out.println(movie.params.fps);               // 20
for (SpriteEntity sprite : movie.sprites) {
  System.out.println(sprite.imageKey);
  for (FrameEntity frame : sprite.frames) {
    for (ShapeEntity shape : frame.shapes) {
      if (shape.type == ShapeEntity.ShapeType.SHAPE && shape.shape != null) {
        System.out.println(shape.shape.d);
      }
    }
  }
}
```

--------------------------------

### Require google-protobuf in svga_pb.js

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

CommonJS module generated with protoc for the google-protobuf (jspb) runtime. Entry point is proto/js/svga_pb.js (3606 lines).

```javascript
var jspb = require('google-protobuf');
```

--------------------------------

### newBuilder (static)

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-protoc.md

Static factory method to create a new builder for the message type. Optionally accepts a prototype message to initialize the builder with.

```APIDOC
## newBuilder (static)

### Description
Static factory method to create a new builder for the message type. Optionally accepts a prototype message to initialize the builder with.

### Method
static newBuilder

### Parameters
- `prototype` (MovieParams) - Optional - A prototype message to initialize the builder with.

### Return Value
Builder - A new builder for the message type.
```

--------------------------------

### MovieEntity repeated field methods

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Methods for managing the repeated `sprites` and `audios` fields on MovieEntity.

```APIDOC
## MovieEntity repeated field methods

### Description
Methods for managing the repeated `sprites` and `audios` fields on MovieEntity.

### Methods
- `getSpritesList()` - Returns the list of sprites.
- `setSpritesList(value)` - Sets the entire list of sprites.
- `addSprites(opt_value, opt_index)` - Adds a sprite to the list, optionally at a specific index.
- `clearSpritesList()` - Clears the list.
- `getAudiosList()` - Returns the list of audios.
- `setAudiosList(value)` - Sets the entire list of audios.
- `addAudios(opt_value, opt_index)` - Adds an audio to the list, optionally at a specific index.
- `clearAudiosList()` - Clears the list.

### Parameters
- `opt_value` (proto.com.opensource.svga.SpriteEntity or proto.com.opensource.svga.AudioEntity) - Optional - The item to add.
- `opt_index` (number) - Optional - The index at which to add the item.

### Returns
- `getSpritesList()` returns an array of `proto.com.opensource.svga.SpriteEntity`.
- `getAudiosList()` returns an array of `proto.com.opensource.svga.AudioEntity`.
- `setSpritesList()` and `setAudiosList()` return void.
- `addSprites()` and `addAudios()` return the added item.
- `clearSpritesList()` and `clearAudiosList()` return void.
```

--------------------------------

### createEmptyInstance()

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/dart.md

Instance method that returns a new empty MovieParams instance.

```APIDOC
## createEmptyInstance()

### Description
Instance method; returns `create()`.

### Method
instance

### Signature
`MovieParams createEmptyInstance()`

### Returns
- **MovieParams** - A new empty message instance.
```

--------------------------------

### toObject(includeInstance, msg)

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Static method that returns a plain-object projection of the message. The instance method toObject delegates here.

```APIDOC
## toObject(includeInstance, msg)

### Description
Static method that returns a plain-object projection of the message. The instance method toObject delegates here.

### Method
`proto.com.opensource.svga.MovieParams.toObject = function(includeInstance, msg)`

### Parameters
- `includeInstance` (boolean) - Required - Whether to include the instance itself.
- `msg` (proto.com.opensource.svga.MovieParams) - Required - The message to convert.

### Returns
- plain `Object` - The plain-object representation.

### Request Example
```js
const obj = proto.com.opensource.svga.MovieParams.toObject(false, msg);
```
```

--------------------------------

### Dart import and re-export of SVGA protobuf bindings

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/dart.md

Entry point of the generated Dart bindings for the SVGA protobuf schema. Imports the protobuf runtime and the enum classes, then re-exports the enums so consumers can access them directly from svga.pb.dart.

```dart
import 'package:protobuf/protobuf.dart' as $pb;
import 'svga.pbenum.dart';
export 'svga.pbenum.dart';
```

--------------------------------

### Build a MovieEntity and serialize with writeToBuffer

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/dart.md

Constructs a MovieEntity with version, params, an image, and a sprite, then serializes it to bytes. Requires the svga.pb.dart package. The image value is a List<int> (e.g., PNG bytes).

```dart
import 'package:svga/svga.pb.dart';

final movie = MovieEntity()
  ..version = '2.0.0'
  ..params = (MovieParams()
    ..viewBoxWidth = 300
    ..viewBoxHeight = 300
    ..fps = 20
    ..frames = 144)
  ..images['awesome'] = pngBytes // List<int>
  ..sprites.add(SpriteEntity()
    ..imageKey = 'awesome'
    ..frames.add(FrameEntity()
      ..alpha = 1.0
      ..transform = (Transform()..a = 1.0 ..d = 1.0)));

final bytes = movie.writeToBuffer(); // List<int>
```

--------------------------------

### MovieParams

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-wire.md

Immutable value object representing the movie parameters message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

```APIDOC
## MovieParams

### Description
Immutable value object representing the movie parameters message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

### Constructor
- `MovieParams(Float viewBoxWidth, Float viewBoxHeight, Integer fps, Integer frames)` - Canonical public constructor in field-tag order.
- `MovieParams(Float viewBoxWidth, Float viewBoxHeight, Integer fps, Integer frames, ByteString unknownFields)` - Constructor with unknown-field preservation.

### Fields
- `viewBoxWidth` (Float) - Immutable field value.
- `viewBoxHeight` (Float) - Immutable field value.
- `fps` (Integer) - Immutable field value.
- `frames` (Integer) - Immutable field value.

### Methods
- `newBuilder()` - Returns a Builder pre-populated from this instance.
- `equals(Object other)` - Value equality.
- `hashCode()` - Hash code.
- `toString()` - Prints tag-numbered `field = value` lines.

### Builder
- `Builder()` - Default constructor.
- `viewBoxWidth(Float viewBoxWidth)` - Fluent setter, returns the builder.
- `viewBoxHeight(Float viewBoxHeight)` - Fluent setter, returns the builder.
- `fps(Integer fps)` - Fluent setter, returns the builder.
- `frames(Integer frames)` - Fluent setter, returns the builder.
- `build()` - Constructs a MovieParams instance.

### Static Members
- `ADAPTER` (ProtoAdapter<MovieParams>) - Wire codec for the message.
- `DEFAULT_VIEWBOXWIDTH` (Float) - Default value 0.0f.
- `DEFAULT_VIEWBOXHEIGHT` (Float) - Default value 0.0f.
- `DEFAULT_FPS` (Integer) - Default value 0.
- `DEFAULT_FRAMES` (Integer) - Default value 0.
```

--------------------------------

### File-level build contract with GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/objective-c.md

Generated header guard that selects framework vs. source imports for CocoaPods. Version guards fail compilation unless the Protocol Buffer runtime matches the protoc version (3.0.2 boundary).

```Objective-C
#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
 #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
#endif

#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
 #import <Protobuf/GPBProtocolBuffers.h>
#else
 #import "GPBProtocolBuffers.h"
#endif

#if GOOGLE_PROTOBUF_OBJC_VERSION < 30002
#error This file was generated by a newer version of protoc which is incompatible with your Protocol Buffer library sources.
#endif
#if 30002 < GOOGLE_PROTOBUF_OBJC_MIN_SUPPORTED_VERSION
#error This file was generated by an older version of protoc which is incompatible with your Protocol Buffer library sources.
#endif
```

--------------------------------

### getDefaultInstanceForType

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-protoc.md

Returns the default instance for the message type. This is an instance method that returns the default instance of the message type.

```APIDOC
## getDefaultInstanceForType

### Description
Returns the default instance for the message type. This is an instance method that returns the default instance of the message type.

### Method
getDefaultInstanceForType

### Parameters
None

### Return Value
MovieParams - The default instance of the message type.
```

--------------------------------

### MovieParams constructor

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Creates a new MovieParams message instance. The optional initial data array is used in place and becomes part of the constructed object.

```APIDOC
## Constructor

### Description
Creates a new MovieParams message instance. The optional initial data array is used in place and becomes part of the constructed object.

### Method
`proto.com.opensource.svga.MovieParams = function(opt_data)`

### Parameters
- `opt_data` (Array=) - Optional - Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned.

### Request Example
```js
new proto.com.opensource.svga.MovieParams(opt_data);
```
```

--------------------------------

### newBuilderForType

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-protoc.md

Returns a new builder instance for the message type. This is an instance method that creates a fresh builder.

```APIDOC
## newBuilderForType

### Description
Returns a new builder instance for the message type. This is an instance method that creates a fresh builder.

### Method
newBuilderForType

### Parameters
None

### Return Value
Builder - A new builder for the message type.
```

--------------------------------

### Transform

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-wire.md

Immutable value object representing the transform message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

```APIDOC
## Transform

### Description
Immutable value object representing the transform message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

### Constructor
- `Transform(...)` - Canonical public constructor in field-tag order.
- `Transform(..., ByteString unknownFields)` - Constructor with unknown-field preservation.

### Fields
- `a` - Immutable field value.
- `b` - Immutable field value.
- `c` - Immutable field value.
- `d` - Immutable field value.
- `tx` - Immutable field value.
- `ty` - Immutable field value.

### Methods
- `newBuilder()` - Returns a Builder pre-populated from this instance.
- `equals(Object other)` - Value equality.
- `hashCode()` - Hash code.
- `toString()` - Prints tag-numbered `field = value` lines.

### Builder
- `Builder()` - Default constructor.
- `a(...)` - Fluent setter, returns the builder.
- `b(...)` - Fluent setter, returns the builder.
- `c(...)` - Fluent setter, returns the builder.
- `d(...)` - Fluent setter, returns the builder.
- `tx(...)` - Fluent setter, returns the builder.
- `ty(...)` - Fluent setter, returns the builder.
- `build()` - Constructs a Transform instance.

### Static Members
- `ADAPTER` (ProtoAdapter<Transform>) - Wire codec for the message.
```

--------------------------------

### MovieEntity.ADAPTER.decode(ByteString) (Wire)

Source: https://github.com/svga/svga-format/blob/master/_autodocs/types.md

Decodes a MovieEntity from a ByteString using the Wire library. Returns a MovieEntity.

```APIDOC
## MovieEntity.ADAPTER.decode(ByteString) (Wire)

### Description
Decodes a MovieEntity from a ByteString using the Wire library. Returns a MovieEntity.

### Method
decode

### Parameters
- **ByteString** (ByteString) - Required - The ByteString to decode.

### Returns
- **MovieEntity** - The decoded MovieEntity object.
```

--------------------------------

### Static deserializeBinary and related methods

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Static utility methods for deserializing binary data and converting to plain objects. The deserializeBinary method parses bytes into a message instance.

```javascript
proto.com.opensource.svga.MovieParams.deserializeBinary = function(bytes) {
  var reader = new jspb.BinaryReader(bytes);
  var msg = new proto.com.opensource.svga.MovieParams();
  return proto.com.opensource.svga.MovieParams.deserializeBinaryFromReader(msg, reader);
};

proto.com.opensource.svga.MovieParams.deserializeBinaryFromReader = function(msg, reader) { ... };
proto.com.opensource.svga.MovieParams.serializeBinaryToWriter = function(message, writer) { ... };
proto.com.opensource.svga.MovieParams.toObject = function(includeInstance, msg) { ... };
```

--------------------------------

### getDefaultInstance

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-protoc.md

Returns the default instance of the message type. This is a static method that provides a singleton default instance.

```APIDOC
## getDefaultInstance

### Description
Returns the default instance of the message type. This is a static method that provides a singleton default instance.

### Method
static getDefaultInstance

### Parameters
None

### Return Value
MovieParams - The default instance of the message type.
```

--------------------------------

### clone()

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/dart.md

Creates a deep copy of the current message instance.

```APIDOC
## clone()

### Description
Deep copy of `this`.

### Method
instance

### Signature
`MovieParams clone()`

### Returns
- **MovieParams** - A deep copy of the current message.
```

--------------------------------

### ShapeEntity.ShapeStyle.RGBAColor

Source: https://github.com/svga/svga-format/blob/master/_autodocs/types.md

RGBA color representation with float channels.

```APIDOC
## ShapeEntity.ShapeStyle.RGBAColor

### Description
RGBA color representation with float channels.

### Fields
- `r` (float) - Required - Red channel.
- `g` (float) - Required - Green channel.
- `b` (float) - Required - Blue channel.
- `a` (float) - Required - Alpha channel.
```

--------------------------------

### Svga.*.parseFrom(...) (protoc Java)

Source: https://github.com/svga/svga-format/blob/master/_autodocs/types.md

Parses a message from bytes in Java using protoc-generated classes. Returns the corresponding message object.

```APIDOC
## Svga.*.parseFrom(...) (protoc Java)

### Description
Parses a message from bytes in Java using protoc-generated classes. Returns the corresponding message object.

### Method
parseFrom

### Parameters
- **bytes** (byte[]) - Required - The binary data to parse.

### Returns
- **Message** - The parsed message object.
```

--------------------------------

### serializeBinary()

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Serializes the message to a binary wire format. Returns the result buffer as a Uint8Array.

```APIDOC
## serializeBinary()

### Description
Serializes the message to a binary wire format. Returns the result buffer as a Uint8Array.

### Method
`proto.com.opensource.svga.MovieParams.prototype.serializeBinary = function()`

### Returns
- `Uint8Array` - The binary wire encoding of this message.

### Request Example
```js
const bytes = message.serializeBinary();
```
```

--------------------------------

### SpriteEntity repeated field methods

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Methods for managing the repeated `frames` field on SpriteEntity.

```APIDOC
## SpriteEntity repeated field methods

### Description
Methods for managing the repeated `frames` field on SpriteEntity.

### Methods
- `getFramesList()` - Returns the list of frames.
- `setFramesList(value)` - Sets the entire list of frames.
- `addFrames(opt_value, opt_index)` - Adds a frame to the list, optionally at a specific index.
- `clearFramesList()` - Clears the list.

### Parameters
- `opt_value` (proto.com.opensource.svga.FrameEntity) - Optional - The frame to add.
- `opt_index` (number) - Optional - The index at which to add the frame.

### Returns
- `getFramesList()` returns an array of `proto.com.opensource.svga.FrameEntity`.
- `setFramesList()` returns void.
- `addFrames()` returns the added frame.
- `clearFramesList()` returns void.
```

--------------------------------

### MovieParams.fromJson(i, [r = ExtensionRegistry.EMPTY])

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/dart.md

Factory constructor that parses a JSON object string according to protobuf JSON mapping. Unknown extensions are resolved using the provided extension registry.

```APIDOC
## MovieParams.fromJson(i, [r = ExtensionRegistry.EMPTY])

### Description
Parses a JSON object string per protobuf JSON mapping.

### Method
factory

### Signature
`MovieParams.fromJson($core.String i, [$pb.ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])`

### Parameters
- **i** (`String`) - Required - The JSON object string.
- **r** (`ExtensionRegistry`) - Optional - Extension registry for resolving unknown extensions. Defaults to `ExtensionRegistry.EMPTY`.

### Returns
- **MovieParams** - A new message instance parsed from the JSON string.
```

--------------------------------

### MovieEntity

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-wire.md

Immutable value object representing the movie entity message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

```APIDOC
## MovieEntity

### Description
Immutable value object representing the movie entity message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

### Constructor
- `MovieEntity(...)` - Canonical public constructor in field-tag order.
- `MovieEntity(..., ByteString unknownFields)` - Constructor with unknown-field preservation.

### Fields
- `version` - Immutable field value.
- `params` - Immutable field value.
- `images` - Immutable field value.
- `sprites` - Immutable field value.
- `audios` - Immutable field value.

### Methods
- `newBuilder()` - Returns a Builder pre-populated from this instance.
- `equals(Object other)` - Value equality.
- `hashCode()` - Hash code.
- `toString()` - Prints tag-numbered `field = value` lines.

### Builder
- `Builder()` - Default constructor.
- `version(...)` - Fluent setter, returns the builder.
- `params(...)` - Fluent setter, returns the builder.
- `images(...)` - Fluent setter, returns the builder.
- `sprites(...)` - Fluent setter, returns the builder.
- `audios(...)` - Fluent setter, returns the builder.
- `build()` - Constructs a MovieEntity instance.

### Static Members
- `ADAPTER` (ProtoAdapter<MovieEntity>) - Wire codec for the message.
```

--------------------------------

### MovieEntity.deserializeBinary (JS)

Source: https://github.com/svga/svga-format/blob/master/_autodocs/types.md

Deserializes a binary MovieEntity in JavaScript. Returns a MovieEntity and traverses all nested types on read.

```APIDOC
## MovieEntity.deserializeBinary (JS)

### Description
Deserializes a binary MovieEntity in JavaScript. Returns a MovieEntity and traverses all nested types on read.

### Method
deserializeBinary

### Parameters
- **bytes** (Uint8Array) - Required - The binary data to deserialize.

### Returns
- **MovieEntity** - The deserialized MovieEntity object.
```

--------------------------------

### serializeBinary instance method

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Serializes the message to a binary buffer using a jspb.BinaryWriter. Returns the result buffer as a Uint8Array.

```javascript
proto.com.opensource.svga.MovieParams.prototype.serializeBinary = function() {
  var writer = new jspb.BinaryWriter();
  this.serializeBinaryToWriter(writer);
  return writer.getResultBuffer();
};
```

--------------------------------

### SpriteEntity

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-wire.md

Immutable value object representing the sprite entity message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

```APIDOC
## SpriteEntity

### Description
Immutable value object representing the sprite entity message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

### Constructor
- `SpriteEntity(...)` - Canonical public constructor in field-tag order.
- `SpriteEntity(..., ByteString unknownFields)` - Constructor with unknown-field preservation.

### Fields
- `imageKey` - Immutable field value.
- `frames` - Immutable field value.
- `matteKey` - Immutable field value.

### Methods
- `newBuilder()` - Returns a Builder pre-populated from this instance.
- `equals(Object other)` - Value equality.
- `hashCode()` - Hash code.
- `toString()` - Prints tag-numbered `field = value` lines.

### Builder
- `Builder()` - Default constructor.
- `imageKey(...)` - Fluent setter, returns the builder.
- `frames(...)` - Fluent setter, returns the builder.
- `matteKey(...)` - Fluent setter, returns the builder.
- `build()` - Constructs a SpriteEntity instance.

### Static Members
- `ADAPTER` (ProtoAdapter<SpriteEntity>) - Wire codec for the message.
```

--------------------------------

### FrameEntity repeated field methods

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Methods for managing the repeated `shapes` field on FrameEntity.

```APIDOC
## FrameEntity repeated field methods

### Description
Methods for managing the repeated `shapes` field on FrameEntity.

### Methods
- `getShapesList()` - Returns the list of shapes.
- `setShapesList(value)` - Sets the entire list of shapes.
- `addShapes(opt_value, opt_index)` - Adds a shape to the list, optionally at a specific index.
- `clearShapesList()` - Clears the list.

### Parameters
- `opt_value` (proto.com.opensource.svga.ShapeEntity) - Optional - The shape to add.
- `opt_index` (number) - Optional - The index at which to add the shape.

### Returns
- `getShapesList()` returns an array of `proto.com.opensource.svga.ShapeEntity`.
- `setShapesList()` returns void.
- `addShapes()` returns the added shape.
- `clearShapesList()` returns void.
```

--------------------------------

### deserializeBinary(bytes)

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Static method that parses a binary payload into a new MovieParams message instance.

```APIDOC
## deserializeBinary(bytes)

### Description
Static method that parses a binary payload into a new MovieParams message instance.

### Method
`proto.com.opensource.svga.MovieParams.deserializeBinary = function(bytes)`

### Parameters
- `bytes` (Uint8Array) - Required - The binary payload to parse.

### Returns
- `proto.com.opensource.svga.MovieParams` - The parsed message instance.

### Request Example
```js
const msg = proto.com.opensource.svga.MovieParams.deserializeBinary(bytes);
```
```

--------------------------------

### MovieParams constructor

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/javascript.md

Constructor for the MovieParams message class. Accepts an optional initial data array that is used in place and not cloned.

```javascript
/**
 * @param {Array=} opt_data Optional initial data array, typically from a
 * server response, or constructed directly in Javascript. The array is used
 * in place and becomes part of the constructed object. It is not cloned.
 * @extends {jspb.Message}
 * @constructor
 */
proto.com.opensource.svga.MovieParams = function(opt_data) {
  jspb.Message.initialize(this, opt_data, 0, -1, null, null);
};
```

--------------------------------

### FrameEntity

Source: https://github.com/svga/svga-format/blob/master/_autodocs/api-reference/java-wire.md

Immutable value object representing the frame entity message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

```APIDOC
## FrameEntity

### Description
Immutable value object representing the frame entity message. Provides a fluent builder and a static ProtoAdapter for wire encoding/decoding.

### Constructor
- `FrameEntity(...)` - Canonical public constructor in field-tag order.
- `FrameEntity(..., ByteString unknownFields)` - Constructor with unknown-field preservation.

### Fields
- `alpha` - Immutable field value.
- `layout` - Immutable field value.
- `transform` - Immutable field value.
- `clipPath` - Immutable field value.
- `shapes` - Immutable field value.

### Methods
- `newBuilder()` - Returns a Builder pre-populated from this instance.
- `equals(Object other)` - Value equality.
- `hashCode()` - Hash code.
- `toString()` - Prints tag-numbered `field = value` lines.

### Builder
- `Builder()` - Default constructor.
- `alpha(...)` - Fluent setter, returns the builder.
- `layout(...)` - Fluent setter, returns the builder.
- `transform(...)` - Fluent setter, returns the builder.
- `clipPath(...)` - Fluent setter, returns the builder.
- `shapes(...)` - Fluent setter, returns the builder.
- `build()` - Constructs a FrameEntity instance.

### Static Members
- `ADAPTER` (ProtoAdapter<FrameEntity>) - Wire codec for the message.
```

--------------------------------

### ShapeEntity.ShapeStyle

Source: https://github.com/svga/svga-format/blob/master/_autodocs/types.md

Style properties for shapes, including fill, stroke, and line settings.

```APIDOC
## ShapeEntity.ShapeStyle

### Description
Style properties for shapes, including fill, stroke, and line settings.

### Fields
- `fill` (RGBAColor) - Optional - Fill color.
- `stroke` (RGBAColor) - Optional - Stroke color.
- `strokeWidth` (float) - Optional - Stroke width.
- `lineCap` (LineCap) - Optional - Line cap style.
- `lineJoin` (LineJoin) - Optional - Line join style.
- `miterLimit` (float) - Optional - Miter limit.
- `lineDashI` (float) - Optional - Dash length.
- `lineDashII` (float) - Optional - Gap length.
- `lineDashIII` (float) - Optional - Dash offset.
```
Tokens:
Raw