MotorCortex-SoundDrag

Table of Contents

MotorCortex-SoundDrag
- Demo
Intro / Features
Getting Started
- Installation
- Importing and Loading
Creating Incidents
- Track
- Extra Effects
Adding Incidents in your clip
Contributing
License
Sponsored by

Demo

Intro / Features

The MotorCortex-SoundDrag is a plugin that allows you to add music or sound effects easily to your clips. Go to sounds.donkeyclip.com find the sound you like to use from a big list of license-free sounds and copy the name of the sound. Then create a new track incident and use the copied name as the value for the attribute key name and you have done.

Getting Started

Installation

$ npm install --save @donkeyclip/motorcortex-sounddrag
# OR
$ yarn add @donkeyclip/motorcortex-sounddrag

Importing and loading

import { loadPlugin } from "@donkeyclip/motorcortex/";
import SoundDragPlugin from "@donkeyclip/motorcortex-sounddrag";
const SoundDrag = loadPlugin(SoundDragPlugin);

Creating Incidents

Track

const newHTMLClip = new SoundDrag.Track(
  {
    name: "Electronic-Violin_16057",
    startFrom: 0,
    duration: 2000,
    fadeIn: false,
    fadeOut: false,
  },
  {
    repeats: 3,
    hiatus: 1000,
    delay: 1000,
    id: "myClip",
  }
);

Track Attrs

Name	Are	Values
name	name of the sound from donkeyclip.sounddrag.com	sting
startFrom	millisecond which sound start playing	num
duration	for how long the sound will play	num
fadeIn	this will enable the fadein effect	boolean
fadeOut	this will enable the fadeout effect	boolean

Extra Effects with AudioEffect

If fadeIn and fadeOut effects are not enough for you, you can create your effects using MotorCortex AudioEffect to apply your custom effect you need an id to select the Audio source this id is "track-id" and then add the incident to the track incident.

Example

const MyEffect = new AudioEffect(
  {
    animatedAttrs: {
      pan: 1,
      gain: 0,
    },
  },
  {
    selector: "~#track-id",
    duration: 3000,
  }
);

trackIncident.addIncident(MyEffect, 1000);

IMPORTANT

You should import AudioEffect from MotorCortex.

import { AudioEffect } from "@donkeyclip/motorcortex";

Adding Incidents in your clip

clipName.addIncident(incidentName,startTime);

Contributing

In general, we follow the "fork-and-pull" Git workflow, so if you want to submit patches and additions you should follow the next steps:

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull request so that we can review your changes

License

MIT License

donkeyclip / motorcortex-sounddrag Goto Github PK