Class Sync

The <sync> element

Parent element: <listening>

The <sync> element specifies the style that a score following application should use the synchronize an accompaniment with a performer. If this element is not included in a score, default synchronization depends on the application.

https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/sync/

Hierarchy

  • Sync

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getLatency getPlayer getTimeOnly getType setLatency setPlayer setTimeOnly setType

Constructors

constructor

Properties

attributes

attributes: SyncAttributes

contents

contents: []

Readonly schema

schema: {
    attributes: {
        latency: {
            type: "optional";
            value: {
                max: number;
                min: 0;
                type: "int";
            };
        };
        player: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        time-only: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "1";
            };
        };
        type: {
            type: "required";
            value: {
                choices: readonly ["none", "tempo", "mostly-tempo", "mostly-event", "event", "always-event"];
                type: "choices";
            };
        };
    };
    contents: readonly [];
    name: "sync";
} = Sync.schema

Type declaration

  • Readonly attributes: {
        latency: {
            type: "optional";
            value: {
                max: number;
                min: 0;
                type: "int";
            };
        };
        player: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        time-only: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "1";
            };
        };
        type: {
            type: "required";
            value: {
                choices: readonly ["none", "tempo", "mostly-tempo", "mostly-event", "event", "always-event"];
                type: "choices";
            };
        };
    }
    • Readonly latency: {
          type: "optional";
          value: {
              max: number;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: number;
            min: 0;
            type: "int";
        }
        • Readonly max: number
        • Readonly min: 0
        • Readonly type: "int"
    • Readonly player: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "_";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "_"
    • Readonly time-only: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "1";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "1";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "1"
    • Readonly type: {
          type: "required";
          value: {
              choices: readonly ["none", "tempo", "mostly-tempo", "mostly-event", "event", "always-event"];
              type: "choices";
          };
      }
      • Readonly type: "required"
      • Readonly value: {
            choices: readonly ["none", "tempo", "mostly-tempo", "mostly-event", "event", "always-event"];
            type: "choices";
        }
        • Readonly choices: readonly ["none", "tempo", "mostly-tempo", "mostly-event", "event", "always-event"]
        • Readonly type: "choices"
  • Readonly contents: readonly []
  • Readonly name: "sync"

Static Readonly schema

schema: {
    attributes: {
        latency: {
            type: "optional";
            value: {
                max: number;
                min: 0;
                type: "int";
            };
        };
        player: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        time-only: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "1";
            };
        };
        type: {
            type: "required";
            value: {
                choices: readonly ["none", "tempo", "mostly-tempo", "mostly-event", "event", "always-event"];
                type: "choices";
            };
        };
    };
    contents: readonly [];
    name: "sync";
} = ...

Type declaration

  • Readonly attributes: {
        latency: {
            type: "optional";
            value: {
                max: number;
                min: 0;
                type: "int";
            };
        };
        player: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        time-only: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "1";
            };
        };
        type: {
            type: "required";
            value: {
                choices: readonly ["none", "tempo", "mostly-tempo", "mostly-event", "event", "always-event"];
                type: "choices";
            };
        };
    }
    • Readonly latency: {
          type: "optional";
          value: {
              max: number;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: number;
            min: 0;
            type: "int";
        }
        • Readonly max: number
        • Readonly min: 0
        • Readonly type: "int"
    • Readonly player: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "_";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "_"
    • Readonly time-only: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "1";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "1";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "1"
    • Readonly type: {
          type: "required";
          value: {
              choices: readonly ["none", "tempo", "mostly-tempo", "mostly-event", "event", "always-event"];
              type: "choices";
          };
      }
      • Readonly type: "required"
      • Readonly value: {
            choices: readonly ["none", "tempo", "mostly-tempo", "mostly-event", "event", "always-event"];
            type: "choices";
        }
        • Readonly choices: readonly ["none", "tempo", "mostly-tempo", "mostly-event", "event", "always-event"]
        • Readonly type: "choices"
  • Readonly contents: readonly []
  • Readonly name: "sync"

Methods

getLatency

getPlayer

getTimeOnly

getType

  • Gets

    Returns "none" | "tempo" | "mostly-tempo" | "mostly-event" | "event" | "always-event"

setLatency

setPlayer

setTimeOnly

setType

Settings

Theme

On This Page

Generated using TypeDoc