@signiant/media-shuttle-sdk-base
Version:
The base parent sdk behind other media shuttle sdks (e.g. media-shuttle-sdk)
26 lines • 893 B
TypeScript
import BasicTransferEventData from './BasicTransferEventData';
import TransferEventType from '../../enums/TransferEventType';
/**
* An event dispatched in response to a change in the transfer state.
*/
interface TransferEvent {
/**
* The type of the event.
*/
type: TransferEventType;
/**
* The data of the event. All event data extends from {@link BasicTransferEventData} but casting (in TypeScript)
* may be necessary to access data to specific event types.
*
* @example
* ```
* if (event.type === TransferEventType.TRANSFER_PROGRESS) {
* const progressData: TransferProgressEventData = <TransferProgressEventData>event.eventData;
* console.log(progressData.bytesTransferred);
* }
* ```
*/
eventData: BasicTransferEventData;
}
export default TransferEvent;
//# sourceMappingURL=TransferEvent.d.ts.map