RTCRtpSFrameTransform.idl   [plain text]

/*
 * Copyright (C) 2020 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

enum RTCRtpSFrameTransformRole {
    "encrypt",
    "decrypt"
};

enum RTCRtpSFrameTransformCompatibilityMode {
    "none",
    "H264",
    "VP8"
};

dictionary RTCRtpSFrameTransformOptions {
    RTCRtpSFrameTransformRole role = "encrypt";
    unsigned long authenticationSize = 10;
    RTCRtpSFrameTransformCompatibilityMode compatibilityMode = "none";
};

[
    Conditional=WEB_RTC,
    EnabledBySetting=WebRTCInsertableStreams,
    ExportMacro=WEBCORE_EXPORT,
    Exposed=(Window,DedicatedWorker),
    InterfaceName=SFrameTransform,
    JSGenerateToNativeObject,
] interface RTCRtpSFrameTransform {
    [CallWith=ScriptExecutionContext] constructor(optional RTCRtpSFrameTransformOptions options);

    [Custom] Promise<undefined> setEncryptionKey(CryptoKey key, optional any keyID);
    // FIXME: Add support for missing methods.
    // Promise<undefined> ratchetEncryptionKey();
    // Promise<undefined> setSigningKey(CryptoKey key);

    [MayThrowException] readonly attribute ReadableStream readable;
    [MayThrowException] readonly attribute WritableStream writable;
};