src/app/clusters/media-input-server/media-input-delegate.h

/*
 *
 *    Copyright (c) 2021 Project CHIP Authors
 *    All rights reserved.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

#pragma once

#include <app-common/zap-generated/cluster-objects.h>
#include <app/AttributeValueEncoder.h>

namespace chip {
namespace app {
namespace Clusters {
namespace MediaInput {

/** @brief
 *    Defines methods for implementing application-specific logic for the Media Input Cluster.
 */
class Delegate
{
public:
    // no easy way to handle the return memory of app::Clusters::MediaInput::Structs::InputInfoStruct::Type list, so encoder is used
    virtual CHIP_ERROR HandleGetInputList(app::AttributeValueEncoder & aEncoder)     = 0;
    virtual uint8_t HandleGetCurrentInput()                                          = 0;
    virtual bool HandleSelectInput(const uint8_t index)                              = 0;
    virtual bool HandleShowInputStatus()                                             = 0;
    virtual bool HandleHideInputStatus()                                             = 0;
    virtual bool HandleRenameInput(const uint8_t index, const chip::CharSpan & name) = 0;

    virtual ~Delegate() = default;
};

} // namespace MediaInput
} // namespace Clusters
} // namespace app
} // namespace chip