[Bug 18531] Consider renaming addKey method

https://www.w3.org/Bugs/Public/show_bug.cgi?id=18531

--- Comment #4 from Mark Watson <watsonm@netflix.com> ---
(In reply to comment #3)
> I think key or license is very similar, and even you want to update a
> license or key, you still need to provide a new key or license.addKey() is
> very clear about proivide key or license to CDM, what the confusion comes
> from?

This method can be used to update the CDM state in a CDM-specific way. For
example, a CDM supporting heartbeat might require regular updates which modify
the expiry time of the license. Is this a new key ? or a new license ? or an
update to an existing license ? That depends on the CDM.

Another example would be secure proof of key release, where this method will be
used to provide an acknowledgement from the server that a proof of key release
message has been received. This is certainly not a new key or new license, but
it does cause an update to the CDM internal state.

> 
> So I think addKey() is clear enough to express its functionality, using
> update() seems confusing me more than addKey(), because app developer will
> not clearly know what can be "update" by update().
> 
> What's more, in webrtc, we have updateIce(), we also use update, but we know
> that we are update configuration of ICE agent.
> 
> 
> 
> 
> 
> 
> (In reply to comment #0)
> > The addKey method can be used for more than just providing a key.
> > Specifically it can be used for
> > - providing a key
> > - providing a license
> > - updating a license or other CDM session state
> > 
> > As a result the addKey name is confusing.
> > 
> > In general, the purpose of this method is to provide a message to the CDM
> > that updates the session state in some CDM-specific way. With the
> > object-oriented model, sessions are explicitly represented by session
> > objects and addKey is a method on that object. With that context we could
> > rename the method to something as simple as update() - it is a method on the
> > session object so the implication is that it updates the session somehow.

-- 
You are receiving this mail because:
You are the QA Contact for the bug.